Skip to main content
POST
Deploy draft release

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <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}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
actions
Actions · object[]
required

Actions available in the release.

mcpClients
MCP clients · object[]
required

MCP clients available in the release.

resources
Resources · object[]
required

Resources available in the release.

capabilities
Capabilities · object[]
required

Capabilities available in the release.

suggestedActions
Suggested actions · object[]
required

Suggested actions to include.

systemPrompt
string

System prompt for the release.

withReasoning
boolean

Whether to include reasoning.

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}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
languageModelSlug
string

Language model identifier.

output
Output · object

Output format for the release.

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
repository
Repository · object | null

Git workspace for a coding harness. Null when unbound. Allowed when a harness slug is set.

version
string

Release version (small semver, e.g. 1.2.3).

Pattern: ^(0|[1-9]\d{0,3})\.(0|[1-9]\d{0,3})\.(0|[1-9]\d{0,4})$
description
string

Release description.

Required string length: 1 - 1000
options
Options · object

Release options.

Response

Deploy draft release

release
Release · object
required

Deployed release details.