Skip to main content
A chat is a conversation thread in your project. The public chats API returns customer-visible chat metadata only. It does not return message bodies or tool/runtime internals. Only customer-visible chats are returned. Internal chats, evaluation chats, and release-generated chats are excluded from this API.

GET /v1/chats

List customer-visible chats for your project. Returns chats in descending created_at order, newest chats first. Pagination is intentionally based on created_at so list traversal stays stable even while a chat continues receiving new messages.

Request

Authorization
string
required
Bearer token. See Authentication.
limit
integer
Number of chats to return. Default 20, max 100.
starting_after
string
Cursor for pagination. Pass the id of the last chat from the previous page.
curl https://app.userjourneys.ai/api/v1/chats \
  -H "Authorization: Bearer uj_live_your_key_here"
{
  "object": "list",
  "data": [
    {
      "id": "7af6cf75-20ec-49f4-b113-929c01dfbe45",
      "object": "chat",
      "title": "Investigate the spike in onboarding drop-off",
      "source": "web",
      "is_streaming": false,
      "created_at": "2026-04-10T15:18:03.000Z",
      "updated_at": "2026-04-10T15:24:18.000Z"
    }
  ],
  "has_more": false
}
Use this endpoint for indexes and linking related resources. Chat message bodies are intentionally not included.

GET /v1/chats/:id

Retrieve a single customer-visible chat with metadata and visible message count.

Request

Authorization
string
required
Bearer token. See Authentication.
id
string
required
Chat ID (UUID).
curl https://app.userjourneys.ai/api/v1/chats/7af6cf75-20ec-49f4-b113-929c01dfbe45 \
  -H "Authorization: Bearer uj_live_your_key_here"
{
  "id": "7af6cf75-20ec-49f4-b113-929c01dfbe45",
  "object": "chat",
  "title": "Investigate the spike in onboarding drop-off",
  "source": "web",
  "is_streaming": false,
  "message_count": 12,
  "created_at": "2026-04-10T15:18:03.000Z",
  "updated_at": "2026-04-10T15:24:18.000Z"
}
This endpoint does not return message bodies. message_count counts visible messages only. Returns 404 if the chat doesn’t exist, doesn’t belong to your project, or is excluded from the public chats API.

Chat object

id
string
Chat ID (UUID).
object
string
"chat"
title
string | null
Chat title, or null if the thread has not been titled.
source
string | null
Where the chat originated. Example values include "web", "analyst", and "mcp". Internal-only sources like "eval" and "releases" are never returned by this API.
is_streaming
boolean | null
Whether the chat is currently streaming a response.
message_count
integer
Number of visible messages in the chat. Only returned by GET /v1/chats/:id.
created_at
string
ISO 8601 timestamp for when the chat was created.
updated_at
string
ISO 8601 timestamp for the most recent update to the chat.