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.

GET /v3/avatar-realtime/{stream_id}

Get Avatar Realtime Session

cURL

curl --request GET \
  --url https://api.heygen.com/v3/avatar-realtime/{stream_id} \
  --header 'x-api-key: <api-key>'

200

{
  "data": {
    "stream_id": "<string>",
    "hls_url": "<string>",
    "error_message": "<string>",
    "end_reason": "<string>"
  }
}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

stream_id · string · required

Streaming session identifier returned by POST /v3/avatar-realtime.

Response

200

application/json

Successful response

data · AvatarRealtimeStatusResponse · object

Response data for GET /v3/avatar-realtime/{stream_id}.

Show child attributes