API reference

Request voice cloning task cancellation

POST/v1/audio-clone/tasks/{task_id}/cancel

Requests cancellation, without guaranteeing cancellation or a refund; ordinary authentication with the same key.

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: idcancel_requested

idstringRequired
cancel_requestedbooleanRequired
Enum
[true]

HTTP 401

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

application/json

Type: object
Required fields: error

errorobjectRequired
error child fields (4)
- codestringOptional
- messagestringOptional
- typestringOptional
- request_idstringOptional

HTTP 403

Insufficient IP, account, model, or tool permissions.

application/json

Type: object
Required fields: error

errorobjectRequired
error child fields (4)
- codestringOptional
- messagestringOptional
- typestringOptional
- request_idstringOptional

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 429

Request/queue rate limit.

application/json

Type: object
Required fields: error

errorobjectRequired
error child fields (4)
- codestringOptional
- messagestringOptional
- typestringOptional
- request_idstringOptional

HTTP 500

Internal authentication or data storage failure.

application/json

Type: object
Required fields: error

errorobjectRequired
error child fields (4)
- codestringOptional
- messagestringOptional
- typestringOptional
- request_idstringOptional

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