COcontextualai
/agents

Get Agent Metadata

Changed on

Get metadata and configuration of a given Agent.

get/agents/{agent_id}/metadata

Request

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

Path parameters

agent_idstring uuid required

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

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.

Changes

  • 4abdda722de9Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body anyOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • c8152db45500Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status