Sign in
Web Search Agent Templates (public)

Get Template

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

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

Changed in 4 of the 55 revisions of this API.78

  • 22c2a22911461See the full diff
    • ●

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

      response-property-enum-value-added

    This revision also has 104 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d4e4f170f4f42See the full diff
    • ○

      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

      api-operation-id-removed

    • ○

      endpoint deprecated

      endpoint-deprecated

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e8a97dc9fce265See the full diff
    • ●

      deleted the cookie request parameter token

      request-parameter-removed

    • ●

      added the new high enum value to the effort response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new low enum value to the effort response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new max enum value to the effort response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new medium enum value to the effort response property for the response status 200

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      api operation id get_template_v2_web_search_agents_templates__template_name__get removed and replaced with get_template_api_v2_public_web_search_agents_templates__template_name__get

      api-operation-id-removed

    • ○

      the endpoint scheme security APIKeyCookie was added to the API

      api-security-added

    • ○

      the endpoint scheme security HTTPBearer was added to the API

      api-security-added

    • ○

      api tag Web Search Agent Templates (public) added

      api-tag-added

    • ○

      api tag Web Search Agents removed

      api-tag-removed

    This revision also has 39 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 421a9851d61b1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog