Skip to main content
GET
/
api
/
chat-agents
List chat agents
curl --request GET \
  --url https://api.upon-ai.com/api/chat-agents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "agent_id": "chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6",
      "agent_name": "Website Concierge",
      "version": 3,
      "response_engine": {
        "type": "uponai-llm",
        "llm_id": "llm_1ab234cde567fgh"
      },
      "auto_close_message": "Thanks for chatting with UponAI.",
      "is_public": true
    }
  ],
  "pagination_key": "chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6",
  "pagination_key_version": 3
}

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.

limit
integer
default:1000

Maximum number of records to return.

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

Identifier to continue pagination.

paginationKeyVersion
integer

Version paired with the pagination key.

Response

200 - application/json

Chat agent summary list.

data
object[]
pagination_key
string | null
pagination_key_version
integer | null