API-Referenz

Videogenerierungsaufgabe erstellen

POST/v1/videos

Persistente Hintergrundprozesse übernehmen Übermittlung, Polling, Abrechnung und Speicherung. Client-Abfragen beobachten nur den Status und lösen keine Abrechnung aus. Gewöhnliche und persistent-Anfragen folgen ihren jeweiligen Modell-/verwalteten Frame-/Kostenvoranschlagsvorgaben. Bei unknown/submission_state_unknown niemals blind mit geändertem Anfrageschlüssel erneut senden.

Normale und persistente Abläufe

Normale Videos verwenden die öffentlichen HTTPS-Eingaben des jeweiligen Modells. Persistente Videos verwenden retention=persistent, ein vollständiges preset aus dem Funktionskatalog, gehostete Frames und einen gültigen Kostenvoranschlag. Mischen Sie keine Frame-Felder des Arbeitsbereichs in normale Anfragen und kombinieren Sie keine Parameter unterschiedlicher preset.

Im Hintergrund werden Ausführung, Abrechnung und Speicherung vorangetrieben; Clientabfragen beobachten nur den Datensatz. Die geschätzte Vorabbuchung kann nachbelastet oder teilweise erstattet werden. Scheitert die Speicherung nach erfolgreicher Generierung, wiederholen Sie die Archivierung des ursprünglichen Ergebnisses, nicht die Generierung. Stellen Sie unbekannte Übermittlungen zuerst anhand des ursprünglichen Anfrageschlüssels wieder her. Siehe Asynchrone Aufgaben und Idempotenz.

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

Anfrageheader

Idempotency-KeystringErforderlich
Mindestlänge
1
Maximale Länge
191
Muster
"^[\\x20-\\x7E]{1,191}$"

Anfragekörper · application/json

Typ: object
Pflichtfelder: modelprompt
Zusätzliche Eigenschaften: false

Anfragekörper erforderlich

modestringOptional
Für persistent erforderlich.

Aufzählung
["text_to_video","image_to_video"]
retentionstringOptional
persistent verwendet den persistenten Arbeitsbereich; ohne Angabe normale Aufgabe.
quote_idstringOptional
Neue persistent-Anfragen erfordern vorherige Bestätigung eines gültigen video-quotes-Angebots.
start_frameobjectOptional
Für persistent Bild-zu-Video erforderlich: gehostete Datei derselben Key. Bei Text-zu-Video verboten.
Unterfelder von start_frame (1)
- file_idstringErforderlich
  Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
allOf-Zweig 1
Typ: object
In diesem Zweig erforderlich: file_id
- file_idstringErforderlich
  Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
end_frameobjectOptional
Optionaler Endframe für persistent, sofern unterstützt.
Unterfelder von end_frame (1)
- file_idstringErforderlich
  Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
allOf-Zweig 1
Typ: object
In diesem Zweig erforderlich: file_id
- file_idstringErforderlich
  Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
webhook_endpoint_idstringOptional
Gewöhnliche Aufgaben dürfen einen in der Konsole konfigurierten Empfänger referenzieren; bei persistent verboten.
modelstringErforderlich
Öffentliche Modell-ID aus dem aktuellen Schlüsselkatalog; garantiert nicht, dass historische Dienstmodelle weiterhin verfügbar sind.
promptstringErforderlich
Generierungsprompt.

Mindestlänge
1
Maximale Länge
2500
durationintegerOptional
Modellabhängige Sekundenanzahl. Vollständige Kombination aus video-models mode.presets verwenden, kein kartesisches Produkt bilden. Wan Turbo unterstützt dieses Feld nicht; kein einheitlicher Standardwert.
image_urlstringOptional
Modellabhängiger HTTPS-Startframe nur für normale Aufgaben; bei persistent verboten.
end_image_urlstringOptional
Modellabhängiger HTTPS-Endframe nur für normale Aufgaben; bei persistent verboten.
resolutionstringOptional
Auflösungswert aus dem Modell-preset.
aspect_ratiostringOptional
Seitenverhältnis aus dem Modell-preset.
generate_audiobooleanOptionalErlaubt null
Modellabhängig; Audiorichtlinie und presets des Modus verwenden. Nicht annehmen, dass alle Modelle Audio generieren.

Antworten und Fehler

HTTP 202

Aufgabe angenommen, nicht zwangsläufig abgeschlossen.

application/json

Typ: object
Pflichtfelder: idmodelstatuscreated_at

updated_atintegerOptional
Letzte Aktualisierung in Unix-Sekunden.
retentionstringOptional
Aufbewahrungspolitik der Ergebnisse; persistent bezeichnet den persistenten Arbeitsbereich.
inputobjectOptional
Ursprüngliche Aufgabeneingabe oder Eingabe gemäß Tool-Vertrag.
Unterfelder von input (14)
- modestringOptional
  Für persistent erforderlich.
  
  Aufzählung
  ["text_to_video","image_to_video"]
- retentionstringOptional
  persistent verwendet den persistenten Arbeitsbereich; ohne Angabe normale Aufgabe.
- quote_idstringOptional
  Neue persistent-Anfragen erfordern vorherige Bestätigung eines gültigen video-quotes-Angebots.
- start_frameobjectOptional
  Für persistent Bild-zu-Video erforderlich: gehostete Datei derselben Key. Bei Text-zu-Video verboten.
  Unterfelder von start_frame (1)
  - file_idstringErforderlich
    Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
  allOf-Zweig 1
  Typ: object
  In diesem Zweig erforderlich: file_id
  - file_idstringErforderlich
    Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
- end_frameobjectOptional
  Optionaler Endframe für persistent, sofern unterstützt.
  Unterfelder von end_frame (1)
  - file_idstringErforderlich
    Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
  allOf-Zweig 1
  Typ: object
  In diesem Zweig erforderlich: file_id
  - file_idstringErforderlich
    Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
- webhook_endpoint_idstringOptional
  Gewöhnliche Aufgaben dürfen einen in der Konsole konfigurierten Empfänger referenzieren; bei persistent verboten.
- modelstringErforderlich
  Öffentliche Modell-ID aus dem aktuellen Schlüsselkatalog; garantiert nicht, dass historische Dienstmodelle weiterhin verfügbar sind.
- promptstringErforderlich
  Generierungsprompt.
  
  Mindestlänge
  1
  Maximale Länge
  2500
- durationintegerOptional
  Modellabhängige Sekundenanzahl. Vollständige Kombination aus video-models mode.presets verwenden, kein kartesisches Produkt bilden. Wan Turbo unterstützt dieses Feld nicht; kein einheitlicher Standardwert.
- image_urlstringOptional
  Modellabhängiger HTTPS-Startframe nur für normale Aufgaben; bei persistent verboten.
- end_image_urlstringOptional
  Modellabhängiger HTTPS-Endframe nur für normale Aufgaben; bei persistent verboten.
- resolutionstringOptional
  Auflösungswert aus dem Modell-preset.
- aspect_ratiostringOptional
  Seitenverhältnis aus dem Modell-preset.
- generate_audiobooleanOptionalErlaubt null
  Modellabhängig; Audiorichtlinie und presets des Modus verwenden. Nicht annehmen, dass alle Modelle Audio generieren.
allOf-Zweig 1
Typ: object
In diesem Zweig erforderlich: model, prompt
Zusätzliche Eigenschaften: false
- modestringOptional
  Für persistent erforderlich.
  
  Aufzählung
  ["text_to_video","image_to_video"]
- retentionstringOptional
  persistent verwendet den persistenten Arbeitsbereich; ohne Angabe normale Aufgabe.
- quote_idstringOptional
  Neue persistent-Anfragen erfordern vorherige Bestätigung eines gültigen video-quotes-Angebots.
- start_frameobjectOptional
  Für persistent Bild-zu-Video erforderlich: gehostete Datei derselben Key. Bei Text-zu-Video verboten.
  Unterfelder von start_frame (1)
  - file_idstringErforderlich
    Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
  allOf-Zweig 1
  Typ: object
  In diesem Zweig erforderlich: file_id
  - file_idstringErforderlich
    Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
- end_frameobjectOptional
  Optionaler Endframe für persistent, sofern unterstützt.
  Unterfelder von end_frame (1)
  - file_idstringErforderlich
    Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
  allOf-Zweig 1
  Typ: object
  In diesem Zweig erforderlich: file_id
  - file_idstringErforderlich
    Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
- webhook_endpoint_idstringOptional
  Gewöhnliche Aufgaben dürfen einen in der Konsole konfigurierten Empfänger referenzieren; bei persistent verboten.
- modelstringErforderlich
  Öffentliche Modell-ID aus dem aktuellen Schlüsselkatalog; garantiert nicht, dass historische Dienstmodelle weiterhin verfügbar sind.
- promptstringErforderlich
  Generierungsprompt.
  
  Mindestlänge
  1
  Maximale Länge
  2500
- durationintegerOptional
  Modellabhängige Sekundenanzahl. Vollständige Kombination aus video-models mode.presets verwenden, kein kartesisches Produkt bilden. Wan Turbo unterstützt dieses Feld nicht; kein einheitlicher Standardwert.
- image_urlstringOptional
  Modellabhängiger HTTPS-Startframe nur für normale Aufgaben; bei persistent verboten.
- end_image_urlstringOptional
  Modellabhängiger HTTPS-Endframe nur für normale Aufgaben; bei persistent verboten.
- resolutionstringOptional
  Auflösungswert aus dem Modell-preset.
- aspect_ratiostringOptional
  Seitenverhältnis aus dem Modell-preset.
- generate_audiobooleanOptionalErlaubt null
  Modellabhängig; Audiorichtlinie und presets des Modus verwenden. Nicht annehmen, dass alle Modelle Audio generieren.
billingobjectOptional
Unabhängiger Abrechnungsstatus; nicht durch den Generierungsstatus ersetzen.
Unterfelder von billing (7)
- currencystringErforderlich
  Währung des Kostenvoranschlags/der Abrechnung.
- error_codestringOptional
  Öffentlicher Fehlercode für Fallunterscheidungen.
- statusstringErforderlich
  Aktueller Objektstatus; getrennt von Abrechnung und Speicherungsstand bewerten.
- reserved_quotaintegerErforderlich
  Reservierung in Plattform-quota-Einheiten, nicht in Dollar.
- final_quotaintegerErforderlichErlaubt null
  Endkosten in Plattform-quota-Einheiten; null bedeutet noch unbestimmt.
- reserved_amountstringErforderlich
  Maximaler Reservierungsbetrag als Zeichenfolge in der Angebotswährung.
- final_amountstringErforderlichErlaubt null
  Endgültiger Betrag als Zeichenfolge; null bedeutet noch nicht abgerechnet.
allOf-Zweig 1
Typ: object
In diesem Zweig erforderlich: currency, status, reserved_quota, final_quota, reserved_amount, final_amount
- currencystringErforderlich
  Währung des Kostenvoranschlags/der Abrechnung.
- error_codestringOptional
  Öffentlicher Fehlercode für Fallunterscheidungen.
- statusstringErforderlich
  Aktueller Objektstatus; getrennt von Abrechnung und Speicherungsstand bewerten.
- reserved_quotaintegerErforderlich
  Reservierung in Plattform-quota-Einheiten, nicht in Dollar.
- final_quotaintegerErforderlichErlaubt null
  Endkosten in Plattform-quota-Einheiten; null bedeutet noch unbestimmt.
- reserved_amountstringErforderlich
  Maximaler Reservierungsbetrag als Zeichenfolge in der Angebotswährung.
- final_amountstringErforderlichErlaubt null
  Endgültiger Betrag als Zeichenfolge; null bedeutet noch nicht abgerechnet.
storageobjectOptional
Unabhängiger Dateispeicherungsstatus.
Unterfelder von storage (3)
- file_idstringOptional
  Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
- statusstringErforderlich
  Aktueller Objektstatus; getrennt von Abrechnung und Speicherungsstand bewerten.
- error_codestringOptional
  Öffentlicher Fehlercode für Fallunterscheidungen.
allOf-Zweig 1
Typ: object
In diesem Zweig erforderlich: status
- file_idstringOptional
  Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
- statusstringErforderlich
  Aktueller Objektstatus; getrennt von Abrechnung und Speicherungsstand bewerten.
- error_codestringOptional
  Öffentlicher Fehlercode für Fallunterscheidungen.
availabilityobjectOptional
Aktuell verfügbare Aktionen.
Unterfelder von availability (4)
- can_cancelbooleanErforderlich
  Ob für die aktuelle Aufgabe ein Abbruch angefordert werden darf.
- can_deletebooleanErforderlich
  Ob die aktuelle Aufgabe gelöscht werden darf.
- can_retry_storagebooleanErforderlich
  Ob die Speicherung der aktuellen Aufgabe erneut versucht werden darf.
- reasonstringOptional
  Öffentlicher Grund für nicht verfügbare Aktion oder Abrechnungsprüfung.
allOf-Zweig 1
Typ: object
In diesem Zweig erforderlich: can_cancel, can_delete, can_retry_storage
- can_cancelbooleanErforderlich
  Ob für die aktuelle Aufgabe ein Abbruch angefordert werden darf.
- can_deletebooleanErforderlich
  Ob die aktuelle Aufgabe gelöscht werden darf.
- can_retry_storagebooleanErforderlich
  Ob die Speicherung der aktuellen Aufgabe erneut versucht werden darf.
- reasonstringOptional
  Öffentlicher Grund für nicht verfügbare Aktion oder Abrechnungsprüfung.
idstringErforderlich
Öffentliche Kennung dieses Objekts für den zugehörigen Detailpfad.
modelstringErforderlich
Öffentliche Modell-ID aus dem Katalog des aktuellen Schlüssels.
statusstringErforderlich
Status gewöhnlicher und persistenter Aufgaben: pending_dispatch/submitting/queued/processing/succeeded/failed/cancelled/unknown. Ein Endzustand bedeutet nicht abgeschlossene Abrechnung oder Archivierung mit ready.
created_atintegerErforderlich
Erstellungszeit in Unix-Sekunden.
resultobjectOptional
Metadaten vorbereiteter Ergebnisse; können vor Abschluss fehlen.
Unterfelder von result (8)
- file_idstringOptional
  Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
- storage_statusstringOptional
  Dateiarchivierungsstatus; verwaltete Downloads sind erst nach ready garantiert verfügbar.
- deliverystringOptional
  authenticated_content erfordert den Inhaltspfad; keine direkte URL voraussetzen.
- content_pathstringOptional
  Plattformauthentifizierter Inhaltspfad; Binärdaten mit demselben Schlüssel anfordern.
- urlstringOptional
  Zugriffs-URL für Ergebnis oder Referenz; signierte URLs gelten nur kurzzeitig.
- content_typestringOptional
  MIME-Typ des Ergebnisses.
- file_namestringOptional
  Öffentlicher Download-Dateiname.
- file_sizeintegerOptional
  Größe der Ergebnisdatei in Bytes.
allOf-Zweig 1
Typ: object
- file_idstringOptional
  Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.
- storage_statusstringOptional
  Dateiarchivierungsstatus; verwaltete Downloads sind erst nach ready garantiert verfügbar.
- deliverystringOptional
  authenticated_content erfordert den Inhaltspfad; keine direkte URL voraussetzen.
- content_pathstringOptional
  Plattformauthentifizierter Inhaltspfad; Binärdaten mit demselben Schlüssel anfordern.
- urlstringOptional
  Zugriffs-URL für Ergebnis oder Referenz; signierte URLs gelten nur kurzzeitig.
- content_typestringOptional
  MIME-Typ des Ergebnisses.
- file_namestringOptional
  Öffentlicher Download-Dateiname.
- file_sizeintegerOptional
  Größe der Ergebnisdatei in Bytes.
errorstringOptional
Öffentliche Fehlerkategorie oder Fehlerobjekt.

HTTP 400

Ungültige Anfrageparameter.

application/json

Typ: object
Pflichtfelder: error

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

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 402

Verfügbares Kontingent des Kontos oder Schlüssels reicht nicht aus.

application/json

Typ: object
Pflichtfelder: error

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

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