> ## 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.

# List chat agents

> List chat agents created inside a workspace.



## OpenAPI

````yaml /openapi.json get /api/chat-agents
openapi: 3.1.0
info:
  title: UponAI Platform API
  version: '2026-04-20'
  description: >-
    Programmatic control plane for configuring UponAI agents, LLM
    configurations, conversation flows, knowledge bases, calls, chats, voices,
    and test tooling. All endpoints require a bearer token obtained from your
    profile settings.
servers:
  - url: https://api.upon-ai.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Calls
    description: Initiate and manage UponAI powered voice and web calls.
  - name: Agents
    description: Configure agents that power calls and web sessions.
  - name: LLM Models
    description: Manage reusable large language model configurations for agents.
  - name: Chat Agents
    description: Configure agents for browser and messaging chat sessions.
  - name: Chats
    description: Start and manage live chat sessions.
  - name: Conversation Flows
    description: Build and maintain reusable dialog graphs for agents.
  - name: Knowledge Bases
    description: Store and curate grounded knowledge sources.
  - name: Voices
    description: Discover, search, add, and clone speech synthesis voices.
  - name: Test Case Definitions
    description: Define simulation test cases for response engines.
  - name: Test Runs
    description: Retrieve results for individual and batch test runs.
  - name: Account
    description: Account level utilities and limits.
  - name: Phone Numbers
    description: List and assign phone numbers to agents.
paths:
  /api/chat-agents:
    get:
      tags:
        - Chat Agents
      summary: List chat agents
      description: List chat agents created inside a workspace.
      parameters:
        - $ref: '#/components/parameters/WorkspaceIdQuery'
        - $ref: '#/components/parameters/LimitQuery'
        - $ref: '#/components/parameters/PaginationKeyQuery'
        - $ref: '#/components/parameters/PaginationKeyVersionQuery'
      responses:
        '200':
          description: Chat agent summary list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAgentList'
              examples:
                default:
                  value:
                    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
components:
  parameters:
    WorkspaceIdQuery:
      name: workspaceId
      in: query
      required: true
      schema:
        type: integer
      description: >-
        Workspace identifier. Call GET /api/workspaces to list workspaces
        accessible to your token.
    LimitQuery:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 1000
      description: Maximum number of records to return.
    PaginationKeyQuery:
      name: paginationKey
      in: query
      required: false
      schema:
        type: string
      description: Identifier to continue pagination.
    PaginationKeyVersionQuery:
      name: paginationKeyVersion
      in: query
      required: false
      schema:
        type: integer
      description: Version paired with the pagination key.
  schemas:
    ChatAgentList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ChatAgentSummary'
        pagination_key:
          type: string
          nullable: true
        pagination_key_version:
          type: integer
          nullable: true
    ChatAgentSummary:
      type: object
      properties:
        agent_id:
          type: string
        agent_name:
          type: string
        version:
          type: integer
        response_engine:
          $ref: '#/components/schemas/ResponseEngine'
        auto_close_message:
          type: string
          nullable: true
        is_public:
          type: boolean
    ResponseEngine:
      type: object
      required:
        - type
      properties:
        type:
          type: string
        llm_id:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Generate tokens from your profile settings at app.uponai.com.

````