Browse documentation

Runs

Cancel active or queued work

Cancels current work or a selected active or queued turn. Requires run:write.

POST/runs/{runId}/cancel

Authorization

AuthorizationBearer <token>

Path parameters

runIdstringrequired

pattern: "^run_[A-Za-z0-9]+$"

Headers

Idempotency-Keystringrequired

minLength: 1
maxLength: 255

Body

application/json

object

Additional properties are not allowed.

turn_idstring

pattern: "^turn_[A-Za-z0-9]+$"

Response

application/json

Run after cancellation

object

Additional properties are allowed.

idstringrequired

pattern: "^run_[A-Za-z0-9]+$"

objectstringrequired

const: "run"

agent_idstringrequired

pattern: "^agt_[A-Za-z0-9]+$"

agent_versionintegerrequired

minimum: 1

statestringrequired

enum: ["idle","busy"]

dispositionstringrequired

enum: ["created_run","created_turn","queued_turn","steered"]

turnobjectrequired

Additional properties are allowed.

Show nested schema

idstringrequired

pattern: "^turn_[A-Za-z0-9]+$"

objectstringrequired

const: "turn"

statusstringrequired

enum: ["queued","in_progress","cancelling","completed","failed","cancelled","incomplete"]

inputarrayrequired

Show nested schema

Array items

object

Additional properties are allowed.

outputarrayrequired

Show nested schema

Array items

union

Exactly one of

object1

object

Additional properties are allowed.

typestringrequired

const: "output_text"

textstringrequired

object2

object

Additional properties are allowed.

typestringrequired

const: "output_file"

file_idstringrequired

filenamestringrequired

media_typestringrequired

created_atintegerrequired

minimum: 0

started_atinteger | nullrequired

minimum: 0

completed_atinteger | nullrequired

minimum: 0

duration_msinteger | nullrequired

minimum: 0

history_statusstringrequired

enum: ["available","expired"]

history_expires_atinteger | nullrequired

minimum: 0

errorunionrequired

Show nested schema

Exactly one of

null1

null

object2

object

Additional properties are allowed.

codestringrequired

sourcestringrequired

enum: ["provider","extension","runtime","platform","configuration"]

messagestringrequired

retryablebooleanrequired

referencestringrequired

curl --request POST \
  --url 'https://YOUR_SALAMBO_BASE_URL/api/v1/runs/{runId}/cancel' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Idempotency-Key: YOUR_IDEMPOTENCY_KEY' \
  --header 'Content-Type: application/json' \
  --data '@request.json'

Replace placeholders before running. JSON templates without a sample body read your payload from request.json.

Response

{
  "id": "<string>",
  "object": "run",
  "agent_id": "<string>",
  "agent_version": 123,
  "state": "idle",
  "disposition": "created_run",
  "turn": {
    "id": "<string>",
    "object": "turn",
    "status": "queued",
    "input": [
      {}
    ],
    "output": [
      {
        "type": "output_text",
        "text": "<string>"
      }
    ],
    "created_at": 123,
    "started_at": 123,
    "completed_at": 123,
    "duration_ms": 123,
    "history_status": "available",
    "history_expires_at": 123,
    "error": null
  }
}