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

# Get Session List

> Retrieve a list of all streaming avatar sessions



## OpenAPI

````yaml GET /api/open/v4/liveAvatar/session/list
openapi: 3.0.3
info:
  title: Live Avatar API
  description: API for managing streaming avatars and sessions
  version: 1.0.0
servers:
  - url: https://openapi.akool.com
    description: Production server
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /api/open/v4/liveAvatar/session/list:
    get:
      tags:
        - Session Management
      summary: Get Session List
      description: Get a list of streaming sessions
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
            minimum: 1
          description: Current page number, default is 1
        - name: size
          in: query
          schema:
            type: integer
            default: 100
            minimum: 1
          description: Number of items per page, default is 100
        - name: status
          in: query
          schema:
            type: integer
            enum:
              - 1
              - 2
              - 3
              - 4
          description: >-
            Session status filter (1:queueing, 2:processing, 3:completed,
            4:failed)
      responses:
        '200':
          description: List of sessions
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/SessionListResponse'
components:
  schemas:
    ApiResponse:
      type: object
      required:
        - code
        - msg
      properties:
        code:
          type: integer
          description: 'Interface returns business status code (1000: success)'
          example: 1000
        msg:
          type: string
          description: Interface returns status information
          example: OK
    SessionListResponse:
      type: object
      properties:
        count:
          type: integer
          description: Total number of sessions
        result:
          type: array
          items:
            $ref: '#/components/schemas/SessionResponse'
    SessionResponse:
      type: object
      properties:
        _id:
          type: string
          description: Session ID
        uid:
          type: integer
          description: User ID
        type:
          type: integer
          description: Session type
        status:
          type: integer
          enum:
            - 1
            - 2
            - 3
            - 4
          description: Session status (1:queueing, 2:processing, 3:completed, 4:failed)
        stream_type:
          type: string
          description: Stream type used for the session
        credentials:
          $ref: '#/components/schemas/Credentials'
    Credentials:
      type: object
      properties:
        agora_uid:
          type: number
          description: Agora SDK user ID (required when stream_type is "agora")
        agora_app_id:
          type: string
          description: Agora App ID (optional when stream_type is "agora")
        agora_channel:
          type: string
          description: Agora channel name (required when stream_type is "agora")
        agora_token:
          type: string
          description: Agora access token (required when stream_type is "agora")
        livekit_url:
          type: string
          description: LiveKit server URL (required when stream_type is "livekit")
        livekit_token:
          type: string
          description: LiveKit access token (required when stream_type is "livekit")
        livekit_room_name:
          type: string
          description: LiveKit room name (optional when stream_type is "livekit")
        livekit_server_identity:
          type: string
          description: LiveKit server identity (optional when stream_type is "livekit")
        livekit_client_identity:
          type: string
          description: LiveKit client identity (optional when stream_type is "livekit")
        trtc_sdk_app_id:
          type: number
          description: TRTC App ID (required when stream_type is "trtc")
        trtc_sdk_room_id:
          type: string
          description: TRTC room ID (required when stream_type is "trtc")
        trtc_sdk_user_id:
          type: string
          description: TRTC user ID (required when stream_type is "trtc")
        trtc_sdk_user_sig:
          type: string
          description: >-
            TRTC authentication token (userSig) (required when stream_type is
            "trtc")
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your API Key used for request authorization. If both Authorization and
        x-api-key have values, Authorization will be used first and x-api-key
        will be discarded.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your API Key used for request authorization. Get Token from
        authentication/usage#get-the-token

````