Cancel Avatar Realtime Session

Cancel a running streaming session. Idempotent: cancelled is true when this request initiated the cancellation, or false when the session was already terminal (completed, failed, or previously cancelled).

POST /v3/avatar-realtime/{stream_id}/cancel

Cancel Avatar Realtime Session

cURL

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

202

{
  "data": {
    "stream_id": "<string>",
    "cancelled": true
  }
}

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

202

application/json

Accepted — submission acknowledged; poll for completion.

data · CancelAvatarRealtimeResponse · object

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

Show child attributes