Documentazione

Riferimento API

Richiedi l'annullamento dell'attività video

POST/v1/videos/{task_id}/cancel

Annullamento secondo modello/attività; 501 indica non supportato. La richiesta non dimostra annullamento né rimborso.

Autenticazione e autorizzazioni

Usa la chiave GloopAPI corrente. Modelli, funzionalità e autorizzazioni disponibili dipendono dal relativo catalogo e dalla documentazione dell'endpoint.

Authorization: Bearer $GLOOP_API_KEY

Schemi di autenticazione: BearerAuth

Richiesta

Parametri del percorso

  • task_idstringObbligatorio

    ID pubblico di un'attività creata con la stessa Key.

Risposte ed errori

HTTP 200

Richiesta riuscita.

application/json

Tipo
object
Campi obbligatori
idcancel_requested

HTTP 401

Key assente, non valida, scaduta o revocata.

application/json

Tipo
object
Campi obbligatori
error

HTTP 403

Key corrente non autorizzata.

application/json

Tipo
object
Campi obbligatori
error
  • errorobjectObbligatorio
    Campi figli di error (3)
    • messagestringObbligatorio
    • typestringObbligatorio
      Enumerazione
      ["new_api_error"]
    • codestringObbligatorio

HTTP 404

Oggetto o funzionalità non disponibile.

application/json

Tipo
object
Campi obbligatori
error
  • errorobjectObbligatorio
    Campi figli di error (3)
    • messagestringObbligatorio
    • typestringObbligatorio
      Enumerazione
      ["new_api_error"]
    • codestringObbligatorio

HTTP 409

Conflitto, risultato non pronto o invio sconosciuto: consulta prima il record originale, senza reinvii alla cieca.

application/json

Tipo
object
Campi obbligatori
error
  • errorobjectObbligatorio
    Campi figli di error (3)
    • messagestringObbligatorio
    • typestringObbligatorio
      Enumerazione
      ["new_api_error"]
    • codestringObbligatorio

HTTP 429

Limite di frequenza delle richieste/della coda.

application/json

Tipo
object
Campi obbligatori
error

HTTP 500

Errore interno di autenticazione o storage dei dati.

application/json

Tipo
object
Campi obbligatori
error

HTTP 501

Il modello video scelto non supporta l'annullamento (cancel_unsupported); non indica un rimborso.

application/json

Tipo
object
Campi obbligatori
error

HTTP 502

Errore nella risposta del servizio.

application/json

Tipo
object
Campi obbligatori
error
  • errorobjectObbligatorio
    Campi figli di error (3)
    • messagestringObbligatorio
    • typestringObbligatorio
      Enumerazione
      ["new_api_error"]
    • codestringObbligatorio

HTTP 503

Servizio, storage, prezzi temporaneamente non disponibile.

application/json

Tipo
object
Campi obbligatori
error
  • errorobjectObbligatorio
    Campi figli di error (3)
    • messagestringObbligatorio
    • typestringObbligatorio
      Enumerazione
      ["new_api_error"]
    • codestringObbligatorio