Dynamiq
Runs

Get a run

Returns a single run. If the run has unresolved human-feedback or approval requests, its status is reported as `awaiting_input` and the pending requests are listed in `input_requests`.

GET
/v1/runs/{run_id}

Authorization

accessKey
AuthorizationBearer <token>

Organization or project Access Key created in the Dynamiq console. Used for deployed-app (Runs API), AI Gateway, traces collector, and management API requests. Send as Authorization: Bearer <access-key>.

In: header

Path Parameters

run_id*string

Run UUID.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": {
    "id": "8c2c8e2e-2f0a-4f4e-9f4f-6e1a52f0a001",
    "status": "awaiting_input",
    "started_at": "2026-06-10T09:15:21Z",
    "input": {
      "ticket_subject": "Refund request over $500"
    },
    "input_requests": [
      {
        "id": "7a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
        "type": "approval_request",
        "prompt": "Approve issuing a $620 refund to customer-7421?",
        "params": {
          "amount": 620,
          "currency": "USD"
        },
        "editable_params": [
          "amount"
        ]
      }
    ]
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Create a run

Starts a run of the deployed app. Three execution modes are supported: **synchronous** (default — the request blocks until the run reaches a terminal state and returns the final run), **background** (`background: true` — returns `202 Accepted` immediately with the created run), and **streaming** (`stream: true` — the response is a Server-Sent Events stream of run events). `stream` and `background` cannot both be true. Files can be attached either by referencing previously uploaded files via `file_ids` or by sending the request as `multipart/form-data` with one or more `files` parts (max 128 MiB).

Cancel a run

Cancels a run that has not reached a terminal state. Cancelling an already completed, failed, or canceled run is a no-op and still returns 200.