Get Video Agent session

Get session status, progress, and paginated chat messages. Poll after creating a session or sending a message.

GET /v3/video-agents/sessions/{session_id}

Get Video Agent session

cURL

curl --request GET \
  --url https://api.heygen.com/v3/video-agents/sessions/{session_id} \
  --header 'x-api-key: <api-key>'

200

{}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

session_id · string · required

Session ID

Response

200

application/json

Successful response

data · GetSessionResponse · object

Response from getting a video agent session.

Show child attributes