Sign in
/agents

Create Agent

Create a new Agent with a specific configuration.

This creates a specialized RAG Agent which queries over one or multiple Datastores to retrieve relevant data on which its generations are grounded.

Retrieval and generation parameters are defined in the provided Agent configuration.

If no datastore_id is provided in the configuration, this API automatically creates an empty Datastore and configures the Agent to use the newly created Datastore.

post/agents

Request body

system_promptstring

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

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.

namestring required

Name of the agent

descriptionstring

Description of the agent

datastore_idsstring[]

The IDs of the datastore to associate with this agent.

Response

Successful Response

idstring uuid required

ID of the agent

datastore_idsstring[] required

IDs of the datastores associated with the agent. If no datastore was provided as part of the request, this is a singleton list containing the ID of the automatically created datastore.

Changes