HEheygen
Models

Create or Retrain an Audio Voice

Changed on

Creates an instant voice with mode: instant from one recording, or a professional voice with mode: professional. Free-plan workspaces can make 20 instant-clone calls per rolling day by default. All members share the workspace limit. Text-based voice design has a separate daily limit. Workspace limits can differ. Instant voices do not support retraining. Use POST /v3/models/audio/tts/stream for streaming speech; model defaults to heygen-voice-1. Instant voices ignore seed, speed and pitch controls. Mode is required for both creation and retraining. Retrains a professional voice when voice_id is set. The voice is PENDING while training; poll GET /v3/models/audio/voices/{voice_id} until it is ACTIVE or FAILED. A new voice in professional mode needs a free professional-voice slot; each purchased slot provides five pooled trainings per monthly billing period, including the first, and failed trainings do not count. Send an Idempotency-Key to make retries safe.

post/v3/models/audio/voices

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/models/audio/voices
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

Idempotency-Keystring

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Request body

OR

Response

Accepted — submission acknowledged; poll for completion.

Changes