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

Stream Agent Run Events

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

Stream a run's progress as 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.

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

text/event-stream

application/json

application/json

curl -X GET "https://example.com/v2/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs/string/events"
"data: {\"type\": \"progress\", \"message\": \"Searching linkedin.com\"}\n\n"

Get Agent Run GET

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

Get Agent Run Result GET

Fetch the output of a completed run. The `output` is `type: "text"` (a prose answer) or `type: "json"` (structured data matching the output schema), plus `trust` metadata with per-claim citations for the answer. While the run is still `queued` or `running` this endpoint returns `409`; if the run `failed` or was `cancelled` it returns `422` with the run and error details.