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

> Lists the open (not yet closed) Streaming Avatar session ids for your workspace, newest first. Session id is the only field returned; use it with `GET /v1/realtime-avatar/sessions/{session_id}` to fetch full state, or `POST /v1/realtime-avatar/sessions/{session_id}/close` to close a session that already ended but still holds a workspace concurrency slot.

<AccordionGroup>
  <Accordion title="Errors">
    See [Session errors](/streaming-avatar/api-references/sessions#errors) for the error codes session endpoints return.
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml streaming-avatar/api-references/openapi.json GET /v1/realtime-avatar/sessions
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/realtime-avatar/sessions:
    get:
      summary: List Sessions
      description: >-
        Lists the open (not yet closed) Streaming Avatar session ids for your
        workspace, newest first. Session id is the only field returned; use it
        with `GET /v1/realtime-avatar/sessions/{session_id}` to fetch full
        state, or `POST /v1/realtime-avatar/sessions/{session_id}/close` to
        close a session that already ended but still holds a workspace
        concurrency slot.
      operationId: listSessions
      parameters:
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Maximum number of session ids to return. Defaults to `100`; the
            maximum accepted value is `200`. Values outside the range fall back
            to the default.
      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:
                      session_ids:
                        type: array
                        items:
                          type: string
                        description: >-
                          Open session ids for the current workspace, ordered by
                          most recently created first. An empty array is
                          returned when there are no open sessions. `page_size`
                          only caps the number of ids returned; it does not
                          paginate, so a single call returns at most `page_size`
                          ids (200 at most). Pass a larger `page_size` to raise
                          the cap when a workspace holds many open sessions.
                    required:
                      - session_ids
              example:
                code: 0
                message: success
                data:
                  session_ids:
                    - avatar-session-345
                    - avatar-session-123
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your Vivix API key. Keep it on your server.

````