NInimbleway
Web Search Agents (public)

Create Run

Changed on

Create a research run for a Web Search Agent instance.

post/v1/task-agents/{agent_id}/runs

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v1/task-agents/{agent_id}/runs
  • Auth
    • HTTP bearer
    • or API key in cookie token

Path parameters

agent_idstring uuid required

Request body

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

Canonical effort tier names for the research graph.

enable_eventsboolean

Whether to stream run events when supported.

inputstring required

User prompt or task instructions for the run.

output_schemaobject nullable

JSON schema overriding the agent's default structured output for this run.

previous_interaction_idstring nullable

Previous interaction identifier used to continue a conversation.

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

    • info

      added the new 5x-high enum value to the request property /

  • d4e4f170f4f4Revision changes
    • breaking

      removed from the request property anyOf list

    • warning

      removed the optional property from the response with the status

    • info

      api operation id create_run_api_v2_public_web_search_agents__agent_id__runs_post removed and replaced with create_run_public_v1_api_v1_public_web_search_agents__agent_id__runs_post

    • info

      endpoint deprecated

    • info

      added the new optional request property

    • info

      added to the request property anyOf list

    • info

      added to the response property anyOf list for the response status

    • info

      removed from the response property anyOf list for the response status