Get Video Agent Session

cURL

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

Responses

200

{
  "data": {
    "session_id": "<string>",
    "status": "thinking",
    "created_at": 123,
    "progress": 0,
    "title": "<string>",
    "video_id": "<string>",
    "messages": [
      {
        "role": "<string>",
        "content": "<string>",
        "type": "text",
        "created_at": 123,
        "resource_ids": [
          "<string>"
        ]
      }
    ]
  }
}

Error Codes

• 400: Bad Request
• 401: Unauthorized
• 404: Not Found
• 429: Too Many Requests

Authorizations

x-api-key

• Type: string
• Location: header
• Required: Yes

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

session_id

• Type: string
• Required: Yes

Session ID

Response Structure

200 - Successful response

• Content-Type: application/json
• Body: