Get Session Resource

cURL

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

Response Status Codes

  • 200
  • 400
  • 401
  • 404
  • 429

Response Structure

{
  "data": {
    "resource_id": "<string>",
    "resource_type": "<string>",
    "source_type": "<string>",
    "url": "<string>",
    "thumbnail_url": "<string>",
    "preview_url": "<string>",
    "created_at": 123,
    "metadata": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.app/llms.txt

Authorizations

ApiKeyAuth

Header Type Required Description
x-api-key string Yes HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

Parameter Type Required Description
session_id string Yes Session ID
resource_id string Yes Resource ID

Response

Status Code 200

Content Type

  • application/json

Successful Response

  • Data Object: SessionResource
    • Simplified session resource for external consumers.