Referência da API

Solicitar cancelamento de tarefa de vídeo

POST/v1/videos/{task_id}/cancel

Cancelamento conforme modelo/tarefa; 501 indica incompatibilidade. Solicitar não significa cancelado ou reembolsado.

Autenticação e permissões

Use sua chave atual do GloopAPI. Modelos, recursos e permissões disponíveis dependem do catálogo da chave e da documentação do endpoint.

Authorization: Bearer $GLOOP_API_KEY

Esquemas de autenticação: BearerAuth

Solicitação

Parâmetros de caminho

task_idstringObrigatório
ID público da tarefa criada com a mesma chave.

Respostas e erros

HTTP 200

Solicitação bem-sucedida.

application/json

Tipo: object
Campos obrigatórios: idcancel_requested

idstringObrigatório
cancel_requestedbooleanObrigatório
Enumeração
[true]

HTTP 401

A chave está ausente, inválida, expirada ou revogada.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 403

A chave atual não tem permissão.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (3)
- messagestringObrigatório
- typestringObrigatório
  Enumeração
  ["new_api_error"]
- codestringObrigatório

HTTP 404

Objeto ou recurso indisponível.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (3)
- messagestringObrigatório
- typestringObrigatório
  Enumeração
  ["new_api_error"]
- codestringObrigatório

HTTP 409

Conflito, não pronto ou envio desconhecido; consulte o original primeiro, sem reenviar às cegas.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (3)
- messagestringObrigatório
- typestringObrigatório
  Enumeração
  ["new_api_error"]
- codestringObrigatório

HTTP 429

Limite de solicitações/fila.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 500

Falha interna de autenticação ou armazenamento de dados.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 501

O modelo de vídeo não aceita cancelamento (cancel_unsupported); isso não significa reembolso.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (4)
- codestringOpcional
- messagestringOpcional
- typestringOpcional
- request_idstringOpcional

HTTP 502

Erro na resposta do serviço.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (3)
- messagestringObrigatório
- typestringObrigatório
  Enumeração
  ["new_api_error"]
- codestringObrigatório

HTTP 503

Serviço, armazenamento, preços temporariamente indisponíveis.

application/json

Tipo: object
Campos obrigatórios: error

errorobjectObrigatório
Campos filhos de error (3)
- messagestringObrigatório
- typestringObrigatório
  Enumeração
  ["new_api_error"]
- codestringObrigatório