NInimbleway
Web Search Agents (public)

Create Agent

Changed on

Create a Web Search Agent instance.

account_id is JWT-derived and never read from the request body.

post/v1/task-agents

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v1/task-agents
  • Auth
    none declared

Request body

agent_namestring nullable

Stable agent name.

descriptionstring nullable

Agent description shown to users.

display_namestring nullable

Human-friendly agent name shown to users.

domain_expertisestring nullable

Domain expertise or operating context for the agent.

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

Canonical effort tier names for the research graph.

goalsstring[]

Ordered goals for the agent to follow.

iconstring nullable

Icon identifier used when presenting the agent.

is_activeboolean

Whether the agent can be used to start new runs.

output_schemaobject nullable

JSON schema describing the structured output the agent should produce.

suggested_questionsstring[]

Suggested prompts users can run with this agent.

templatestring nullable

Template name to materialize this instance from. When set, the scalar fields and child rows are copied from the template.

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

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

  • 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
    • warning

      removed the request property

    • 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 create_agent_api_v2_public_web_search_agents_post removed and replaced with create_agent_public_v1_api_v1_public_web_search_agents_post

    • 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