Nimble API
Nimble Docsnimbleway.com
HomeAPI ReferenceSDKsContext Plugin
Public A P I

Get Agent Run

GET
/v2/agents/{agent_id}/runs/{run_id}

Retrieve a run's current state. Poll this endpoint after creating a run: the run is finished once status is completed, failed, or cancelled.

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agent_id*Agent Id

Web Search Agent ID, format wsa_<uuid>.

Formatuuid
run_id*Run Id

Run ID, format task_run_<uuid>.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v2/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs/string"
{  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "effort": "low",  "error": {    "message": "string",    "ref_id": "string"  },  "id": "string",  "interaction_id": "string",  "is_active": true,  "prompt": "string",  "started_at": "2019-08-24T14:15:22Z",  "status": "queued",  "web_search_agent_id": "string"}

Create Agent Run POST

Start an agent run. The run executes asynchronously: the response returns immediately with status `queued`, then poll `GET .../runs/{run_id}` until `completed` and fetch the output from `GET .../runs/{run_id}/result` — or set `enable_events: true` and follow `GET .../runs/{run_id}/events` for live progress. To enrich existing records instead of researching from scratch, pass them in `input_data`; this requires an `output_schema` (on the request or the agent).

Stream Agent Run Events GET

Stream a run's progress as [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) (`text/event-stream`). Create the run with `enable_events: true` to have events published. A keep-alive comment is sent every 15 seconds.