Using The New Public API
Capri now offers a public API for our V3 (beta) users to engage with agents they've built and trained with our platform to be used with any other public REST API!
Last updated
Capri now offers a public API for our V3 (beta) users to engage with agents they've built and trained with our platform to be used with any other public REST API!
Last updated
To get started, sign up for a new account at https://beta.capriai.us and start a 2 week free trial! You'll need an account to get your Agent ID and Token. See the Quickstart Guides for information on setting up an agent (use the "Beta" section)!
You'll need a Capri API Token to authorize your API Calls. Grab it here.
POST
https://api.capriai.us/v1/conversation/query
Send a user query and receive the final response as well as all intermediate actions that your agent predicted during it's conversation turn.
Authorization*
(required) The value should be
"Bearer {YourCapriToken}", with a space in between "bearer" and your token, and no brackets.
For example, "Bearer oxoxooxoxxo"
agent*
String
sessionId*
String
(required) Any random string, provided by the application calling the capri API. Minimum of 8 unique characters required.
message*
String
(required) The user's query to be responded to by the agent
Response Parameters:
Upon successfully calling the export conversations API, you will receive a JSON response structured as follows:
Ensure to handle potential errors when making the API call:
401: Unauthorized - Check if the API token is correct and has the necessary permissions.
400: Bad Request - Ensure all mandatory parameters are included and valid.
By managing both successes and errors effectively, you can seamlessly integrate conversation data into your workflow.
(required) The desired agent ID, found at the very end of the URL of your agent's details page