Web Search Agents (public)
get/v1/task-agents/{agent_id}

Request

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

Path parameters

agent_idstring uuid required

Response

Successful Response

agent_namestring nullable

Stable agent name.

created_atstring date-time required

When the agent was created.

descriptionstring required

Agent description shown to users.

display_namestring required

Human-friendly agent name shown to users.

domain_expertisestring required

Domain expertise or operating context for the agent.

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

Canonical effort tier names for the research graph.

iconstring required

Icon identifier used when presenting the agent.

idstring required

Unique web search agent identifier (wsa_<uuid>).

is_activeboolean required

Whether the agent can be used to start new runs.

output_schemaobject nullable required

JSON schema describing the structured output the agent should produce.

updated_atstring date-time required

When the agent was last updated.

use_case'research' | 'enrichment' | 'dataset_building' required

Changes

    • warning

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

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id get_agent_api_v2_public_web_search_agents__agent_id__get removed and replaced with get_agent_public_v1_api_v1_public_web_search_agents__agent_id__get

    • info

      endpoint deprecated

    • info

      the response's property default value was removed for the status

    • info

      the response's property default value was removed for the status

    • info

      added the required property /// to the response with the status