List Video Translations

cURL

curl --request GET \
  --url 'https://api.heygen.com/v3/video-translations?limit=10' \
  --header 'x-api-key: <api-key>'

Response Codes

  • 200
  • 400
  • 401
  • 429

Example Response

{
  "data": [
    {
      "id": "<string>",
      "status": "pending",
      "title": "<string>",
      "output_language": "<string>",
      "input_language": "<string>",
      "duration": 123,
      "translate_audio_only": true,
      "video_url": "<string>",
      "audio_url": "<string>",
      "srt_caption_url": "<string>",
      "vtt_caption_url": "<string>",
      "callback_id": "<string>",
      "created_at": 123,
      "failure_message": "<string>"
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Authorizations

ApiKeyAuth

  • x-api-key
    • Type: string
    • Location: header
    • Required: Yes
    • Description: HeyGen API key. Obtain from your HeyGen dashboard.

Query Parameters

  • limit
    • Type: integer
    • Default: 10
    • Description: Maximum number of items per page. Required range: 1 <= x <= 100
  • token
    • Type: string
    • Description: Opaque cursor token for the next page.

Response Details

  • 200
    • Content-Type: application/json
    • Description: Successful response.

Attributes

  • data: VideoTranslationDetail ยท object[]
  • has_more: boolean
    • Description: Whether more pages are available.
  • next_token: string | null
    • Description: Opaque cursor for the next page.