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!

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)!

Authorization

You'll need a Capri API Token to authorize your API Calls. Grab it here.

Base URL:

// https://api.capriai.us/v1/{endpoint}

Conversations

https://api.capriai.us/v1/conversation/query

Request:

Query your Capri Ai Agent

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.

Request Header

Name	Description
Authorization*	(required) The value should be "Bearer {YourCapriToken}", with a space in between "bearer" and your token, and no brackets. For example, "Bearer oxoxooxoxxo"

Request Body

Name	Type	Description
agent*	String	(required) The desired agent ID, found at the very end of the URL of your agent's details page https://beta.capriai.us/home/agents
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

200: OK Successful

Response Parameters:

{
  "finalResponse" : //Your agent's final conversational response,
  "actions" : //array of actions your agent took during it's turn
       [
           {
              "eventId" : //unique Id representing the action
              "sender" : //who sent the message ('bot' or 'human'),
              "kind" : // the kind of action (i.e., googleSheet, ghlCalendar, etc),
              "accountId" : //id of which resource was used for this action,
              "accountName" : //name of which resource was used for this action,
              "deleted" : //boolean, represents if a user manually corrected the action from the emulator,
              "action" : //the action type (i.e., 'read', 'write', tag', etc),
              "eventData" : //event details (optional, only present if required such as calendar event dates and time ranges)
              "reference" : //reference url for the resource that was used (optional),
              "timestamp" : //time the action took place (epoch time in milliseconds)
           },
           {...}
        ]
}

401: Unauthorized Invalid or API Token not found

{
    "message": string,
    "error": 'Unauthorized'
    "statusCode": 401
}

400: Bad Request Invalid request body. Most commonly occurs when a required request parameter is missing or invalid

{
    "message": string,
    "error": 'Bad Request'
    "statusCode": 400
}