HEheygen
Video Agent

Get Video Agent Session

Changed on

Returns the current status, progress, video_id, and recent chat messages for a session.

get/v3/video-agents/{session_id}

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/video-agents/{session_id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

session_idstring required

Session ID

Response

Successful response

Example response

{
  "data": {
    "error": {
      "code": "free_tier_quota_exceeded",
      "message": "You've reached your plan's video generation quota. Upgrade your plan to continue generating videos."
    }
  }
}

Changes

  • 7dfa5e59b4f5Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status