Deployments.ai Docs
Workflows

Start an immutable workflow release

POST /v1/workflow-releases/{workflowReleaseId}/executions · SDK startWorkflowExecution · CLI deployments workflow-execution start

POST
/v1/workflow-releases/{workflowReleaseId}/executions

Requires workflows:execute.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Path Parameters

workflowReleaseId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string

Must contain 1–256 UTF-8 bytes with no surrounding whitespace or control characters (U+0000–U+001F and U+007F); maxLength is only a character-count approximation.

Match^(?!\s)(?!.*\s$)[^\u0000-\u001F\u007F]+$
Length1 <= length <= 256

Request Body

application/json
  1. body
input?
workspaceId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Response Body

WorkflowExecutionResponse

application/json
  1. response
environmentId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
projectId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
completedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
currentStepAttempt?integer
Range0 <= value
currentStepId?string
Match^\S[\s\S]*\S$|^\S$|^$
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
startedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
status*string
Value in"queued""running""waiting-for-agent""waiting-for-tool""waiting-for-approval""waiting-for-delivery""completed""failed""canceling""canceled"
updatedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
version*integer
Range0 <= value
workflowContentHash*string
Match^sha256:[a-f0-9]{64}$
workflowDefinitionId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
workflowReleaseId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
workflowReleaseNumber*integer
Range0 < value
workspaceId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
error?
input*
object*"workflow-execution"
Value in"workflow-execution"
output?
curl -X POST "https://example.com/v1/workflow-releases/string/executions" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "environmentId": "string",  "organizationId": "string",  "projectId": "string",  "completedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "currentStepAttempt": 0,  "currentStepId": "string",  "id": "string",  "startedAt": "2019-08-24T14:15:22Z",  "status": "queued",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0,  "workflowContentHash": "string",  "workflowDefinitionId": "string",  "workflowReleaseId": "string",  "workflowReleaseNumber": 1,  "workspaceId": "string",  "error": {    "property1": null,    "property2": null  },  "input": {    "property1": null,    "property2": null  },  "object": "workflow-execution",  "output": {    "property1": null,    "property2": null  }}