API-Referenz

Abbruch einer Videoaufgabe anfordern

POST/v1/videos/{task_id}/cancel

Modell-/aufgabenabhängiger Abbruch; 501 bedeutet nicht unterstützt. Eine Abbruchanfrage bedeutet weder bereits abgebrochen noch erstattet.

Authentifizierung und Berechtigungen

Verwenden Sie Ihren aktuellen GloopAPI-Schlüssel. Verfügbare Modelle, Funktionen und Berechtigungen hängen von seinem Katalog und der Endpunktdokumentation ab.

Authorization: Bearer $GLOOP_API_KEY

Authentifizierungsschemata: BearerAuth

Anfrage

Pfadparameter

task_idstringErforderlich
Öffentliche ID einer mit demselben Schlüssel erstellten Aufgabe.

Antworten und Fehler

HTTP 200

Anfrage erfolgreich.

application/json

Typ: object
Pflichtfelder: idcancel_requested

idstringErforderlich
cancel_requestedbooleanErforderlich
Aufzählung
[true]

HTTP 401

Key fehlt, ist ungültig, abgelaufen oder widerrufen.

application/json

Typ: object
Pflichtfelder: error

errorobjectErforderlich
Unterfelder von error (4)
- codestringOptional
- messagestringOptional
- typestringOptional
- request_idstringOptional

HTTP 403

Der aktuelle Schlüssel hat keine Berechtigung.

application/json

Typ: object
Pflichtfelder: error

errorobjectErforderlich
Unterfelder von error (3)
- messagestringErforderlich
- typestringErforderlich
  Aufzählung
  ["new_api_error"]
- codestringErforderlich

HTTP 404

Objekt oder Funktion nicht verfügbar.

application/json

Typ: object
Pflichtfelder: error

errorobjectErforderlich
Unterfelder von error (3)
- messagestringErforderlich
- typestringErforderlich
  Aufzählung
  ["new_api_error"]
- codestringErforderlich

HTTP 409

Anfragekonflikt, nicht bereit oder Übermittlung unbekannt. Zuerst den ursprünglichen Datensatz abfragen; nicht blind erneut senden.

application/json

Typ: object
Pflichtfelder: error

errorobjectErforderlich
Unterfelder von error (3)
- messagestringErforderlich
- typestringErforderlich
  Aufzählung
  ["new_api_error"]
- codestringErforderlich

HTTP 429

Anfrage-/Warteschlangenlimit.

application/json

Typ: object
Pflichtfelder: error

errorobjectErforderlich
Unterfelder von error (4)
- codestringOptional
- messagestringOptional
- typestringOptional
- request_idstringOptional

HTTP 500

Interner Authentifizierungs- oder Datenspeicherungsfehler.

application/json

Typ: object
Pflichtfelder: error

errorobjectErforderlich
Unterfelder von error (4)
- codestringOptional
- messagestringOptional
- typestringOptional
- request_idstringOptional

HTTP 501

Das gewählte Videomodell unterstützt keinen Abbruch (cancel_unsupported); dies bedeutet nicht, dass eine Erstattung erfolgt ist.

application/json

Typ: object
Pflichtfelder: error

errorobjectErforderlich
Unterfelder von error (4)
- codestringOptional
- messagestringOptional
- typestringOptional
- request_idstringOptional

HTTP 502

Fehler in der Dienstantwort.

application/json

Typ: object
Pflichtfelder: error

errorobjectErforderlich
Unterfelder von error (3)
- messagestringErforderlich
- typestringErforderlich
  Aufzählung
  ["new_api_error"]
- codestringErforderlich

HTTP 503

Dienst, Speicherung, Preisberechnung vorübergehend nicht verfügbar.

application/json

Typ: object
Pflichtfelder: error

errorobjectErforderlich
Unterfelder von error (3)
- messagestringErforderlich
- typestringErforderlich
  Aufzählung
  ["new_api_error"]
- codestringErforderlich