Skip to main content
POST
/
ai
/
chats
Create chat
curl --request POST \
  --url https://api.getcargo.io/v1/ai/chats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "trigger": {
    "type": "<string>",
    "connectorUuid": "<string>",
    "meta": {}
  },
  "name": "<string>",
  "agentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "chat": {
    "uuid": "<string>",
    "slug": "<string>",
    "workspaceUuid": "<string>",
    "userUuid": "<string>",
    "agentUuid": "<string>",
    "releaseUuid": "<string>",
    "name": "<string>",
    "trigger": "<unknown>",
    "activeStreamUuid": "<string>",
    "creditsUsedCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "lastMessage": {
      "uuid": "<string>",
      "workspaceUuid": "<string>",
      "agentUuid": "<string>",
      "releaseUuid": "<string>",
      "chatUuid": "<string>",
      "userUuid": "<string>",
      "errorMessage": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "finishedAt": "<string>",
      "deletedAt": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

​
trigger
Trigger · object
required

Trigger configuration for the chat.

​
name
string

Chat name.

​
agentUuid
string<uuid>

Agent identifier for the chat.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
​
releaseUuid
string<uuid>

Release identifier for the chat.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Successful response

​
chat
Chat · object
required

Created chat details.