v21

latestOpenAPI 3.1.0raw.githubusercontent.com2026-01-1340148239.5 KB

/agents

Get Template Configuration

get/agents/templates/{template}

Path parameters

templatestring required

Template for which to get config

Response

Successful Response

namestring required

Name of the agent

descriptionstring

Description of the agent

datastore_idsstring[] required

The IDs of the datastore(s) associated with the agent

template_namestring required

The template used to create this agent.

system_promptstring

Instructions that your agent references when generating responses. Note that we do not guarantee that the system will follow these instructions exactly.

filter_promptstring

The prompt to an LLM which determines whether retrieved chunks are relevant to a given query and filters out irrelevant chunks. This prompt is applied per chunk.

no_retrieval_system_promptstring

Instructions on how the agent should respond when there are no relevant retrievals that can be used to answer a query.

multiturn_system_promptstring

Instructions on how the agent should handle multi-turn conversations.

suggested_queriesstring[]

These queries will show up as suggestions in the Contextual UI when users load the agent. We recommend including common queries that users will ask, as well as complex queries so users understand the types of complex queries the system can handle. The max length of all the suggested queries is 1000.