Skip to main content
GET
/
ai
/
chats
/
list
List chats
curl --request GET \
  --url https://api.getcargo.io/v1/ai/chats/list \
  --header 'Authorization: Bearer <token>'
{
  "chats": [
    {
      "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>",
        "status": "pending",
        "errorMessage": "<string>",
        "type": "user",
        "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.

Query Parameters

​
agentUuid
string<uuid>

Filter chats by agent identifier.

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>

Filter chats by release identifier.

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})$
​
userUuid
string<uuid>

Filter chats by user identifier.

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})$
​
triggerType
enum<string>

Filter chats by trigger type.

Available options:
connector,
draft,
web_extension,
app,
workflow
​
messageStatuses
enum<string>[]

Filter chats by their last message status.

Available options:
pending,
generating,
success,
error,
cancelling,
cancelled
​
name
string

Filter chats by name (partial match).

​
createdAfter
string

Filter chats created after this ISO date.

​
createdBefore
string

Filter chats created before this ISO date.

​
limit
string

Maximum number of chats to return.

​
offset
string

Number of chats to skip.

Response

Successful response

​
chats
Chats · object[]
required

List of chats.