Documentation

API reference

Create a voice cloning task

POST/v1/audio-clone/tasks

Uses ordinary TokenAuth; queries may also be rejected when quota is exhausted, unlike the relaxed authentication for persistent images/videos. Creation defaults to audio-clone-v1 with background polling. Never blindly resend unknown submissions.

Recovery boundaries for cloning tasks

Clone creation and subsequent queries use ordinary authentication. Reserve sufficient quota and retain the original API key. Do not assume cloning allows queries with an exhausted key just because images/videos do.

Cloning has no request-key recovery endpoint equivalent to persistent images. After a network timeout, retain diagnostics and known task information, and investigate the task before proceeding; do not blindly submit again. Evaluate execution success and result storage status separately too.

Authentication and permissions

Use your current GloopAPI key. Available models, capabilities and permissions depend on its catalog and the endpoint documentation.

Authorization: Bearer $GLOOP_API_KEY

Authentication schemes: BearerAuth

Request

Request headers

  • Idempotency-KeystringOptional
    Maximum length
    191
    Pattern
    "^[\\x20-\\x7E]{0,191}$"

Request body · application/json

Type
object
Required fields
textreference_audio_urlreference_text

Request body required

  • modelstringOptional

    Public model ID from the current key's catalog.

    Default value
    "audio-clone-v1"
    Enum
    ["audio-clone-v1"]
  • textstringRequired

    Text to synthesize.

    Minimum length
    1
    Maximum length
    5000
  • reference_audio_urlstringRequired

    Public HTTPS reference audio URL; user information is prohibited and SSRF checks apply.

  • reference_textstringRequired

    Text corresponding to the reference audio.

    Minimum length
    1
    Maximum length
    5000
  • remove_silencebooleanOptionalAllows null

    Whether to remove silence; defaults to true when omitted.

    Default value
    true

Responses and errors

HTTP 202

The task was accepted; this does not mean it is complete.

application/json

Type
object
Required fields
idstatuscreated_at

HTTP 400

Invalid request parameters.

application/json

Type
object
Required fields
error
  • errorobjectRequired
    error child fields (3)
    • messagestringRequired
    • typestringRequired
      Enum
      ["new_api_error"]
    • codestringRequired
      Enum
      ["invalid_request","invalid_reference_audio_url","text_too_long","idempotency_conflict","insufficient_quota","task_not_found","task_not_ready","task_failed","submission_state_unknown","upstream_unavailable","upstream_protocol_error"]

HTTP 401

The key is missing, invalid, expired, or revoked.

application/json

Type
object
Required fields
error

HTTP 402

Insufficient available account or key quota.

application/json

Type
object
Required fields
error
  • errorobjectRequired
    error child fields (3)
    • messagestringRequired
    • typestringRequired
      Enum
      ["new_api_error"]
    • codestringRequired
      Enum
      ["invalid_request","invalid_reference_audio_url","text_too_long","idempotency_conflict","insufficient_quota","task_not_found","task_not_ready","task_failed","submission_state_unknown","upstream_unavailable","upstream_protocol_error"]

HTTP 403

Insufficient IP, account, model, or tool permissions.

application/json

Type
object
Required fields
error

HTTP 409

Request conflict, not ready, or submission unknown. Query the original record first; never blindly resend.

application/json

Type
object
Required fields
error
  • errorobjectRequired
    error child fields (3)
    • messagestringRequired
    • typestringRequired
      Enum
      ["new_api_error"]
    • codestringRequired
      Enum
      ["invalid_request","invalid_reference_audio_url","text_too_long","idempotency_conflict","insufficient_quota","task_not_found","task_not_ready","task_failed","submission_state_unknown","upstream_unavailable","upstream_protocol_error"]

HTTP 429

Request/queue rate limit.

application/json

Type
object
Required fields
error

HTTP 500

Internal authentication or data storage failure.

application/json

Type
object
Required fields
error

HTTP 503

Service, storage, pricing, or model temporarily unavailable.

application/json

Type
object
Required fields
error
  • errorobjectRequired
    error child fields (3)
    • messagestringRequired
    • typestringRequired
      Enum
      ["new_api_error"]
    • codestringRequired
      Enum
      ["invalid_request","invalid_reference_audio_url","text_too_long","idempotency_conflict","insufficient_quota","task_not_found","task_not_ready","task_failed","submission_state_unknown","upstream_unavailable","upstream_protocol_error"]