NInimbleway
Web Search Agent Templates (public)

Get Template

Changed on
get/v1/task-agents/templates/{template_name}

Request

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

Path parameters

template_namestring required

Response

Successful Response

created_atstring date-time required

When the template was created.

descriptionstring required

Template description shown to users.

display_namestring required

Human-friendly template name shown to users.

domain_expertisestring required

Domain expertise or operating context for the template.

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 template.

idstring required

Unique template identifier (wsat_<uuid>).

output_schemaobject nullable required

JSON schema describing the structured output the agent should produce.

template_namestring required

Stable template name used to create agent instances.

updated_atstring date-time required

When the template 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

  • d4e4f170f4f4Revision changes
    • info

      api operation id get_template_api_v2_public_web_search_agents_templates__template_name__get removed and replaced with get_template_public_v1_api_v1_public_web_search_agents_templates__template_name__get

    • info

      endpoint deprecated