Sign in
/agents

Get Agent Metadata

Get metadata and configuration of a given Agent.

get/agents/{agent_id}/metadata

Path parameters

agent_idstring uuid required

ID of the agent for which to retrieve details

ID of the agent for which to retrieve details

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

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.

llm_model_idstring

The model ID to use for generation. Tuned models can only be used for the agents on which they were tuned. If no model is specified, the default model is used. Set to default to switch from a tuned model to the default model.

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.

Changes