Documentation

API reference

Request video task cancellation

POST/v1/videos/{task_id}/cancel

Model/task-dependent cancellation; 501 means unsupported. Requesting cancellation does not mean the task is cancelled or refunded.

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

HTTP 401

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

application/json

Type
object
Required fields
error

HTTP 403

The current key lacks permission.

application/json

Type
object
Required fields
error
  • errorobjectRequired
    error child fields (3)
    • messagestringRequired
    • typestringRequired
      Enum
      ["new_api_error"]
    • codestringRequired

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

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

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 501

The selected video model does not support cancellation (cancel_unsupported); this does not mean a refund has occurred.

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

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