COcontextualai
/agents

Create Agent

Changed on

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.

Note that self-serve users are currently required to create agents through our UI. Otherwise, they will receive the following message: "This endpoint is disabled as you need to go through checkout. Please use the UI to make this request."

post/agents

Request

  • Base URL
    https://api.contextual.ai/v1
  • URL
    https://api.contextual.ai/v1/agents
  • Auth
    HTTP bearer

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.

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.

filter_promptstring

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

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

  • 4abdda722de9Revision changes
    • breaking

      the request property type changed from string to no type

    • info

      added the new optional request property //

    • info

      added subschema #2 to the request property anyOf list

  • c8152db45500Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property