Skip to main content
GET
/
api
/
chats
List chats
curl --request GET \
  --url https://api.upon-ai.com/api/chats \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "chatId": "<string>",
      "agentId": "<string>",
      "version": 123,
      "status": "<string>",
      "type": "web_chat",
      "metadata": {},
      "customAttributes": {},
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "transcript": "<string>",
      "messages": [
        {
          "content": "<string>",
          "name": "<string>",
          "tool_calls": [
            {}
          ]
        }
      ],
      "chatCost": {},
      "chatAnalysis": {},
      "collectedDynamicVariables": {},
      "uponai_dynamic_variables": {},
      "overrideDynamicVariables": {}
    }
  ],
  "pagination_key": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://documentation.uponai.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Generate tokens from your profile settings at app.uponai.com.

Query Parameters

​
workspaceId
integer
required

Workspace identifier. Call GET /api/workspaces to list workspaces accessible to your token.

​
sortOrder
enum<string>

Sort direction for chat listings.

Available options:
ascending,
descending
​
limit
integer
default:1000

Maximum number of records to return.

Required range: 1 <= x <= 1000
​
paginationKey
string

Identifier to continue pagination.

Response

200 - application/json

Chat session list.

​
data
object[]
​
pagination_key
string | null