Query
Changed onStart a conversation with an Agent and receive its generated response, along with relevant retrieved data and attributions.
Request
- Base URLhttps://api.contextual.ai/v1
- URLhttps://api.contextual.ai/v1/agents/{agent_id}/query
- AuthHTTP bearer
Path parameters
Agent ID of the agent to query
Query parameters
Set to true to fetch retrieval content and metadata, and then skip generation of the response.
Set to true to include the text of the retrieved contents in the response. If false, only metadata about the retrieved contents will be included, not content text. This parameter is ignored if retrievals_only is true, in which case content_text will always be returned. Content text and other metadata can also be fetched separately using the /agents/{agent_id}/query/{message_id}/retrieval/info endpoint.
Request body
Response
Successful Response
Changes
- info
added the new optional request property
/
- info
- breaking
response property
retrieval_contents/items/custom_metadata/additionalProperties/list-of-types was widened by adding typesarrayto media typeapplication/jsonof response200 - info
added the new optional request property
// - info
added the optional property
/to the response with the status - info
added the optional property
//to the response with the status
- breaking