Skip to main content
GET
List chats

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <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,
cli,
workflow,
schedule,
chat,
native
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).

Case-insensitive partial match on chat name or slug.

Minimum string length: 1
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

List chats

chats
Chats · object[]
required

List of chats.