NInimbleway
Public API

Get Agent Run

Changed on

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/v2/agents/{agent_id}/runs/{run_id}

Request

  • Base URL
    https://sdk.nimbleway.com
  • Auth
    none declared

Path parameters

agent_idstring uuid required
run_idstring required

Response

Successful Response

completed_atstring date-time nullable

When the run completed.

created_atstring date-time required

When the run was created.

effort'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max' required

Canonical effort tier names for the research graph.

idstring required

Run identifier, format "task_run_{uuid}".

interaction_idstring required

Interaction ID.

is_activeboolean required

True while status is 'queued' or 'running'.

promptstring nullable

Prompt submitted for the run.

started_atstring date-time nullable

When the run started executing.

status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required

Lowercase status values used in API responses (distinct from the DB-level TaskRunStatus enum).

web_search_agent_idstring required

Web Search Agent instance this run belongs to.

Changes