Start a run

POST/api/v1/runs

scope runs:startIdempotentCosts 10 rate-limit units

Asks an assistant to do something, and returns immediately with a queued run — the work happens in the background, so poll GET /runs/{id} or subscribe to the assistant.run_completed webhook rather than waiting on this call. A run bound to a contact or conversation may reply on your channels. One run at a time per conversation: starting a second returns 409 conflict with reason: run_already_active. Refused with 402 when the account’s monthly AI budget is exhausted, and with 422 assistant_disabled when the assistant is switched off.

Body

application/json

Name	Type	Description
`assistant_id`required	`string (uuid)`	The assistant to run
`goal`required	`string`	What you want it to do, in plain language
`contact_id`optional	`string (uuid) \| null`	The contact this is about. Its most recent conversation is used if there is one
`conversation_id`optional	`string (uuid) \| null`	Reply in this specific thread instead of resolving one from the contact

Request

curl -X POST "https://your-crm.example.com/api/v1/runs" \
  -H "Authorization: Bearer $RAABTA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2a9e-3b4d-4c5e-8f7a-9b0c1d2e3f4a" \
  -d '{
    "assistant_id": "8f2c1d3e-4a5b-4c6d-9e0f-1a2b3c4d5e6f",
    "goal": "Follow up with Ayesha about her missed appointment and offer to rebook.",
    "contact_id": "9d7e4c11-5a2b-4f7c-8e3d-2a1b0c9d8e7f"
  }'

Response · 202 Accepted

{
  "data": {
    "id": "3f9a1c2e-5b7d-4e8f-9a0b-1c2d3e4f5a6b",
    "assistant_id": "8f2c1d3e-4a5b-4c6d-9e0f-1a2b3c4d5e6f",
    "assistant": {
      "id": "8f2c1d3e-4a5b-4c6d-9e0f-1a2b3c4d5e6f",
      "name": "Front desk",
      "color": "#0ea5e9"
    },
    "status": "queued",
    "goal": "Follow up with Ayesha about her missed appointment and offer to rebook.",
    "trigger": {
      "type": "manual",
      "trigger_id": null,
      "trigger_name": null,
      "event_key": null
    },
    "contact_id": "9d7e4c11-5a2b-4f7c-8e3d-2a1b0c9d8e7f",
    "conversation_id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
    "parent_run_id": null,
    "root_run_id": "3f9a1c2e-5b7d-4e8f-9a0b-1c2d3e4f5a6b",
    "depth": 0,
    "result": null,
    "tick_count": 0,
    "cost_usd": 0,
    "error_code": null,
    "error_message": null,
    "started_at": "2026-09-02T09:00:00.000Z",
    "ended_at": null,
    "created_at": "2026-09-02T09:00:00.000Z"
  }
}

Response

Wrapped in { data: … }

Name	Type	Description
`id`required	`string (uuid)`	Run id
`assistant_id`required	`string (uuid)`	The assistant running
`assistant`required	`object \| null`	The assistant, or null if it has since been deleted
`assistant.id`required	`string (uuid)`	Assistant id
`assistant.name`required	`string`	Assistant name
`assistant.color`required	`string \| null`	Accent colour
`status`required	`string (enum)`	Where the run is in its lifecycle`queuedrunningwaiting_replywaiting_approvalwaiting_childrencompletedfailedcancelled`
`goal`required	`string`	What this run was asked to do
`trigger`required	`object`	Where the run came from
`trigger.type`required	`string`	One of manual, inbound_message, schedule, event, webhook or delegation
`trigger.trigger_id`required	`string (uuid) \| null`	The assistant trigger, when one fired it
`trigger.trigger_name`required	`string \| null`	That trigger name
`trigger.event_key`required	`string \| null`	The event key, for an event trigger
`contact_id`required	`string (uuid) \| null`	The contact it concerns, if any
`conversation_id`required	`string (uuid) \| null`	The thread it may answer in, if any
`parent_run_id`required	`string (uuid) \| null`	Set when this is a sub-agent of another run
`root_run_id`required	`string (uuid) \| null`	The top of the delegation tree
`depth`required	`integer`	0 for a root run
`result`required	`object \| null`	Present once the run has ended
`result.outcome`required	`string \| null`	How it ended, in one word
`result.summary`required	`string \| null`	One line on what happened
`tick_count`required	`integer`	Model turns this run has taken
`cost_usd`required	`number`	Billed AI spend attributed to this run
`error_code`required	`string \| null`	Machine code when the run failed
`error_message`required	`string \| null`	Operator-facing failure text
`started_at`required	`string (date-time)`	When the run was created
`ended_at`required	`string (date-time) \| null`	When it reached a terminal status
`created_at`required	`string (date-time)`	When the row was written

Errors

Status	Code	When
400	`bad_request`	The request could not be parsed: malformed JSON, an invalid cursor, or a query parameter of the wrong shape.
400	`validation_error`	The body or query failed validation. `details` lists each failing field with a `path` and a `message`.
401	`unauthorized`	No usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
402	`plan_limit_reached`	The account has reached a plan limit for this resource. `details[0].limit` is the cap; ask the account owner to raise it.
403	`forbidden`	The key is valid but lacks the scope this endpoint requires, or the request came from an address outside the key’s IP allowlist. The message says which.
403	`account_suspended`	The account this key belongs to is suspended. Rotating the key will not help; contact support.
404	`not_found`	No such resource in this account. A resource that exists in another account also returns this.
409	`conflict`	The request conflicts with current state: a duplicate phone number on create, an invalid state transition, or an idempotent request that is still in flight.
422	`unprocessable`	The request was well-formed but cannot be carried out. `reason` is a stable string saying why (for example `outside_window` or `stage_not_in_pipeline`).
429	`rate_limited`	The per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500	`internal`	Something failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.