Skip to main content
GET
Get Agent Template

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

template_name
string
required

Stable template name, e.g. linkedin_company_profiles.

Response

Successful Response

created_at
string<date-time>
required

When the template was created.

description
string
required

Template description shown to users.

display_name
string
required

Human-friendly template name shown to users.

effort
enum<string>
required

Default effort level for runs created from this template.

Available options:
low,
medium,
high,
x-high,
max
Example:

"high"

goals
WebSearchAgentGoalResponsePublicV2 · object[]
required

Ordered goals for the template.

icon
string
required

Icon identifier used when presenting the template.

id
string
required

Unique template identifier (wsat_).

Example:

"wsat_7d1e4f7a-9f3c-4a7b-b0d0-1c2c3d4e5f60"

output_schema
Output Schema · object | null
required

JSON schema describing the structured output the agent should produce.

skill
string
required

Skill or operating context for the template.

sources
WebSearchAgentSourceResponsePublicV2 · object[]
required

Ordered source groups for the template.

suggested_questions
WebSearchAgentSuggestedQuestionResponsePublicV2 · object[]
required

Suggested prompts for the template.

template_name
string
required

Stable template name used to create agent instances.

Example:

"linkedin_company_profiles"

updated_at
string<date-time>
required

When the template was last updated.

use_case
enum<string>
required

Primary use case supported by the template.

Available options:
research,
enrichment,
dataset_building
Example:

"research"