Documentation

API reference

Get voice cloning results

GET/v1/audio-clone/tasks/{task_id}/result

Query after background completion. Result archival status is independent of success. Failure returns 422; not ready or unknown returns 409.

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

Path parameters

  • task_idstringRequired

    Public ID of a task created with the same key.

Responses and errors

HTTP 200

Request succeeded.

application/json

Type
object
Required fields
idstatusresultusage
  • idstringRequired
  • statusstringRequired
    Enum
    ["succeeded"]
  • resultobjectRequired
    result child fields (6)
    • file_idstringOptional

      Public ID of a managed file for the same account and key.

    • storage_statusstringOptional

      File archival status; managed downloads are only guaranteed after ready.

    • audio_urlstringRequired

      Generated audio access URL; when managed, the storage layer provides a signed URL.

    • content_typestringOptional

      Result MIME type.

    • file_namestringOptional

      Public download filename.

    • file_sizeintegerOptional

      Result file size in bytes.

  • usageobjectRequired
    usage child fields (1)

HTTP 401

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

application/json

Type
object
Required fields
error

HTTP 403

Insufficient IP, account, model, or tool permissions.

application/json

Type
object
Required fields
error

HTTP 404

Object or capability 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"]

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 422

Generation failed.

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 502

Service response error.

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 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"]