List Chats

GET /api/v1/chats
Bearer auth

Retrieves a paginated list of chat sessions for the user's organization.

Query parameters

  • limit integer

    Number of chats per page

    Default value is 20.

  • offset integer

    Offset for pagination

    Default value is 0.

Responses

  • 200 application/json

    List of chats

    Hide response attributes Show response attributes object
    • created_at string Required
    • id integer Required
    • messages array[object] Required
      Hide messages attributes Show messages attributes object
      • chat_id integer Required
      • content string Required
      • created_at string Required
      • id integer Required
      • metadata string Required

        Store MessageMetadata as JSON string

      • role string Required
    • metadata string Required

      Store ChatMetadata as JSON string

    • organization_id integer Required
    • tags string Required

      JSON array of tags as string

    • title string Required
    • updated_at string Required
    • user_id integer Required

      Nullable for anonymous chats
  • 401 application/json

    Unauthorized (JWT invalid/missing or Org ID not found)

    Hide response attribute Show response attribute object
    • * string Additional properties
  • 500 application/json

    Failed to list chats

    Hide response attribute Show response attribute object
    • * string Additional properties
GET /api/v1/chats 
curl \
 --request GET 'http://api.example.com/api/v1/chats' \
 --header "Authorization: $API_KEY"
Response examples (200) 
[
  {
    "created_at": "string",
    "id": 42,
    "messages": [
      {
        "chat_id": 42,
        "content": "string",
        "created_at": "string",
        "id": 42,
        "metadata": "string",
        "role": "string"
      }
    ],
    "metadata": "string",
    "organization_id": 42,
    "tags": "string",
    "title": "string",
    "updated_at": "string",
    "user_id": 42
  }
]
Response examples (401) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}
Response examples (500) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}