> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vivix.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Characters

> Lists undeleted characters in the current workspace, newest first. The list does not return the full `avatars` / `pipeline_config`; it returns summary fields only.



## OpenAPI

````yaml streaming-avatar/api-references/openapi.json GET /v1/characters
openapi: 3.1.0
info:
  title: Vivix Streaming Avatar API
  version: 1.0.0
  description: REST endpoints for Streaming Avatar sessions, voices, and characters.
servers:
  - url: https://api.vivix.ai
security:
  - bearerAuth: []
paths:
  /v1/characters:
    get:
      summary: List Characters
      description: >-
        Lists undeleted characters in the current workspace, newest first. The
        list does not return the full `avatars` / `pipeline_config`; it returns
        summary fields only.
      operationId: listCharacters
      parameters:
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
          description: Page size. Defaults to 50; maximum 200.
        - name: page_token
          in: query
          required: false
          schema:
            type: string
          description: >-
            The `next_page_token` from the previous response. An invalid token
            returns `20004`.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - message
                  - data
                properties:
                  code:
                    type: integer
                    description: '`0` on success; any other value is an error code.'
                  message:
                    type: string
                    description: '`success`, or an English error description.'
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        description: Character summaries, newest first.
                        items:
                          type: object
                          properties:
                            character_id:
                              type: string
                              description: Character id.
                            name:
                              type: string
                              description: Display name.
                            model:
                              type: string
                              description: |-
                                Model ID saved with this character.

                                The `model` from the stored config.
                            resolution:
                              type: string
                              description: >-
                                `output.resolution` from the stored config, when
                                present.
                            created_at:
                              type: string
                              format: date-time
                              description: UTC.
                            updated_at:
                              type: string
                              format: date-time
                              description: UTC.
                          required:
                            - character_id
                            - name
                            - model
                            - resolution
                            - created_at
                            - updated_at
                      next_page_token:
                        type: string
                        description: >-
                          Cursor for the next page. Empty string when there is
                          no next page.
                    required:
                      - items
                      - next_page_token
              example:
                code: 0
                message: success
                data:
                  items:
                    - character_id: chr_a1b2c3d4e5f6789012345678abcdef01
                      name: Studio Host
                      model: vivix-a1-stream
                      resolution: 720p
                      created_at: '2026-08-19T10:00:00Z'
                      updated_at: '2026-08-19T10:00:00Z'
                  next_page_token: ''
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your Vivix API key. Keep it on your server.

````