get
/List conversations
Newest first by updated_at, as the app lists them. A conversation that gets a new message or a new title moves to the front, so it can appear again on a later page.
| Name | In | Required | Description |
|---|---|---|---|
| workspace_id | path | yes | The workspace (project) id. |
| limit | query | no | Page size. Default 25, max 100. |
| cursor | query | no | The next_cursor of the previous page. Opaque. |
Responses
- 200 A page of conversations. (ConversationList)
- 401 Missing, malformed, unknown or revoked API key. (ErrorResponse)
- 403 The account has no paid plan. (ErrorResponse)
- 404 The workspace does not exist or is not visible to this key's owner. (ErrorResponse)
- 422 Invalid limit or cursor. (ErrorResponse)
- 429 Rate limit exceeded. Wait the number of seconds in Retry-After. (ErrorResponse)
- 500 Unexpected error. Retry later and quote request_id if it persists. (ErrorResponse)
200 response schema
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "Changes when a message is added or the conversation is renamed."
},
"message_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Messages the user sees in the conversation (their own and the companion's replies)."
}
},
"required": [
"id",
"title",
"created_at",
"updated_at",
"message_count"
]
}
},
"next_cursor": {
"description": "Pass as ?cursor to get the next page. Null on the last page.",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next_cursor"
]
}