Skip to main content
PUT
Update draft release

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Scopes

openid

OpenID Connect identity.

profile

Name and profile claims.

email

Email address.

offline_access

Refresh token.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

agentUuid
string<uuid>
required

Agent identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
actions
Actions · object[]

Actions available in the draft release.

mcpClients
MCP clients · object[]

MCP clients available in the draft release.

resources
Resources · object[]

Resources available in the draft release.

capabilities
Capabilities · object[]

Capabilities available in the draft release.

suggestedActions
Suggested actions · object[]

Suggested actions to include.

systemPrompt
string

System prompt for the draft release.

withReasoning
boolean

Whether to include reasoning.

effort
enum<string> | null

How hard the model thinks: a coding harness's effort (Codex's reasoning effort; OpenCode ignores it), or the provider's reasoning effort on a plain model call when reasoning is on.

Available options:
low,
medium,
high,
xhigh,
max
temperature
number

Sampling temperature.

maxSteps
number

Maximum number of steps.

integrationSlug
string

LLM provider integration.

connectorUuid
string<uuid>

LLM connector.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
languageModelSlug
string

Language model identifier.

parentUuid
string<uuid>

Parent release identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
output
Output · object

Output format for the draft release. Pass null to inherit text output.

heartbeat
Heartbeat · object | null

Heartbeat configuration for chats created from this release. Pass null to disable.

evaluator
Evaluator · object | null

Evaluator configuration (rubric + quality threshold) used to grade agent output. Pass null to disable.

harnessSlug
enum<string> | null

Coding-agent runtime. Null means streamText.

Available options:
claudeCode,
codex,
openCode,
deepAgents
stateUuid
string<uuid> | null

Project (state) the coding harness works on. It must be in this workspace and its repository connected; its repository, directory and production branch are what the sandbox clones.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
envVars
Harness env vars · object[] | null

Environment variables available to the harness's code execution.

runAsUserUuid
string<uuid> | null

Service user the harness turn runs as. When set, the sandbox receives a temporary CARGO_API_TOKEN for that user.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
repository
any
options
Options · object

Draft release options.

Response

Update draft release

release
Release · object
required

Updated draft release details.