Create Run Chain

Create a multi-step chain that runs on a single reserved session/machine.

• Starts a new session unless session_id is provided (then runs on existing session).
• Accepts shared_inputs/sensitive/file_inputs and per-step file_inputs.
• machine_id > pool_id when starting a new session; both ignored if session_id provided.
• Client contract: once runs are persisted, failures in downstream Temporal dispatch do not change the HTTP success envelope; response still contains run_ids and those runs are transitioned to ERROR with failure metadata for deterministic polling.

POST /v1/runs/chain

Create Run Chain

cURL

curl --request POST \
  --url https://api.cyberdesk.io/v1/runs/chain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "steps": [
    {
      "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session_alias": "<string>",
      "inputs": {},
      "sensitive_inputs": {}
    }
  ],
  "shared_inputs": {},
  "shared_sensitive_inputs": {},
  "shared_file_inputs": [
    {
      "filename": "<string>",
      "content": "<string>",
      "target_path": "<string>",
      "cleanup_imports_after_run": false
    }
  ],
  "keep_session_after_completion": false,
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pool_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

201

{
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key · string

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Request to create and run a multi-step chain on a single reserved session/machine

steps · ChainStep · object[] · required

Minimum array length: 1

Show child attributes

shared_inputs · Shared Inputs · object

shared_sensitive_inputs · Shared Sensitive Inputs · object

Shared sensitive inputs (supports nested objects) for all steps

shared_file_inputs · FileInput · object[] | null

Show child attributes

keep_session_after_completion · boolean | null · default: false

machine_id · string<uuid> | null

pool_ids · string<uuid>[] | null

Pool IDs to filter available machines when starting a new session. Machine must belong to ALL of these pools (intersection). Ignored when machine_id is provided.

session_id · string<uuid> | null

Response

201

application/json

Returns persisted run_ids for the created chain session. If Temporal dispatch fails after run persistence, this endpoint still returns 201 with run_ids; those runs are marked ERROR and include failure details in subsequent run reads.

Response for chain creation

session_id · string<uuid> · required

run_ids · string<uuid>[] · required