COcontextualai
/agents

Edit Agent

Changed on

Modify a given Agent to utilize the provided configuration.

Fields not included in the request body will not be modified.

put/agents/{agent_id}

Request

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

Path parameters

agent_idstring uuid required

ID of the agent to edit

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

Name of the agent

descriptionstring

Description of the agent

datastore_idsstring[]

IDs of the datastore to associate with the agent.

Response

Successful Response

EmptyResponse required

Changes

  • 4abdda722de9Revision changes
    • info

      added the new optional request property //

  • c8152db45500Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property