NInimbleway
Web Search Agents (public)

Get Run

Changed on

Fetch a run by id, scoped to the instance.

A run resolves only when (run_id, agent_id) match — otherwise 404. This means a stale URL with a swapped agent_id won't leak runs across instances even if the run_id is real.

get/v1/task-agents/{agent_id}/runs/{run_id}

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v1/task-agents/{agent_id}/runs/{run_id}
  • 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

  • 22c2a2291146Revision changes
    • warning

      added the new 5x-high enum value to the response property for the response status

  • d4e4f170f4f4Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      api operation id get_run_api_v2_public_web_search_agents__agent_id__runs__run_id__get removed and replaced with get_run_public_v1_api_v1_public_web_search_agents__agent_id__runs__run_id__get

    • info

      endpoint deprecated

    • info

      added to the response property anyOf list for the response status

    • info

      removed from the response property anyOf list for the response status