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.

workflowUuid
string<uuid>
required

Workflow whose draft to deploy.

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})$
nodes
Nodes · object[]
required

Nodes to persist on the deployed release.

formFields
Form fields · object[] | null
required

Form fields for tool-style releases. Pass null when the release has none.

version
string

Version to assign to the deployed release.

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

Human-readable description of this release.

Required string length: 1 - 1000
options
Options · object

Optional remapping of connectors and models by integration slug.

Response

Deploy draft release

release
object
required