> ## Documentation Index
> Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Avatar Realtime Session

> Get the status of a streaming avatar session. `status` is one of `pending` (workflow starting), `streaming` (the `hls_url` is live), `completed` (finished — `end_reason` describes how), or `error` (`error_message` describes the failure). Poll this after POST /v3/avatar-realtime until `hls_url` is present.



## OpenAPI

````yaml /openapi/external-api.json get /v3/avatar-realtime/{stream_id}
openapi: 3.1.0
info:
  title: HeyGen External API
  version: 1.0.0
  description: >-
    HeyGen's external API for programmatic AI video creation. See
    https://docs.heygen.com for full documentation.
  contact:
    name: HeyGen Product Infra
    url: https://heygen.com
servers:
  - url: https://api.heygen.com
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Video Agent
    description: Create videos from text prompts using AI
  - name: Videos
    description: Create, list, retrieve, and delete videos
  - name: Voices
    description: Text-to-speech and voice management
  - name: Audio
    description: Search the background-music and sound-effects catalog
  - name: Video Translate
    description: Translate videos into other languages
  - name: User
    description: Account information and billing
  - name: Avatars
    description: List and manage avatars and looks
  - name: Avatar Realtime
    description: >-
      Low-latency streaming avatar sessions — create a stream, poll for its HLS
      URL, push text, consume per-word timestamps
  - name: Assets
    description: Upload files for use in video creation
  - name: Webhooks
    description: Manage webhook endpoints and events
  - name: Lipsync
    description: Dub or replace audio on existing videos
  - name: Brand
    description: >-
      Brand-related resources — brand kits (colors, fonts, logos) and brand
      glossaries (custom term translations)
  - name: HyperFrames
    description: Render HyperFrames composition zips into video — separate from /v3/videos
  - name: AI Clipping
    description: Turn long-form videos into ready-to-share short clips with captions
paths:
  /v3/avatar-realtime/{stream_id}:
    get:
      tags:
        - Avatar Realtime
      summary: Get Avatar Realtime Session
      description: >-
        Get the status of a streaming avatar session. `status` is one of
        `pending` (workflow starting), `streaming` (the `hls_url` is live),
        `completed` (finished — `end_reason` describes how), or `error`
        (`error_message` describes the failure). Poll this after POST
        /v3/avatar-realtime until `hls_url` is present.
      operationId: getAvatarRealtimeSession
      parameters:
        - name: stream_id
          in: path
          required: true
          schema:
            type: string
          description: Streaming session identifier returned by POST /v3/avatar-realtime.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AvatarRealtimeStatusResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: authentication_failed
                  message: Invalid or expired API key. Verify your x-api-key header.
                  param: null
                  doc_url: null
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: not_found
                  message: Streaming session not found.
                  param: null
                  doc_url: null
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Retry after the duration specified in the
                    Retry-After header.
                  param: null
                  doc_url: null
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    AvatarRealtimeStatusResponse:
      description: Response data for GET /v3/avatar-realtime/{stream_id}.
      properties:
        stream_id:
          description: Streaming session identifier.
          title: Stream Id
          type: string
        status:
          description: >-
            Session status: 'pending' (workflow in progress), 'streaming' (HLS
            URL available), 'completed' (workflow finished — `end_reason`
            describes how), or 'error' (workflow failed).
          enum:
            - pending
            - streaming
            - completed
            - error
          title: Status
          type: string
        hls_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: HLS streaming session URL. Present only when status is 'streaming'.
          title: Hls Url
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Error description. Present only when status is 'error'.
          title: Error Message
        end_reason:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            How a 'completed' session terminated. 'final_marker' — producer sent
            `final: true`. 'idle_timeout' — producer went silent and the emitter
            finalized. Only present for text_stream sessions and only when
            status is 'completed'.
          title: End Reason
      required:
        - stream_id
        - status
      title: AvatarRealtimeStatusResponse
      type: object
    StandardAPIError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: invalid_parameter
        message:
          type: string
          description: Human-readable error message
          example: Video not found
        param:
          type:
            - string
            - 'null'
          description: Which request field caused the error
        doc_url:
          type:
            - string
            - 'null'
          description: Link to error documentation
      required:
        - code
        - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: HeyGen API key. Obtain from your HeyGen dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth2 bearer token.

````