API-verwysing

Konvensies

Elke /v1/*-endpoint vereis die Authorization: Bearer sk_...-kopstuk. Foute kom terug as JSON met 'n error-vlag en 'n message:

{
  "error": true,
  "message": "length must be a positive multiple of 30 seconds, at most 360"
}

Generasie-endpoints is tot 20 versoeke per minuut beperk. Alle ander endpoints deel 'n limiet van 200 per minuut.

Skep 'n verduideliking

Begin 'n generasie en gee 202 Accepted terug met die rekord in die tou. Poll kry 'n verduideliking totdat dit ready is.

{
  "input": "Explain how DNS resolves a domain name",
  "length": "0:30",
  "aspect": "16:9",
  "voice": "sketchie:sulafat",
  "language": "en"
}

Gee die verduidelikingsrekord terug: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null tot gereed) en sceneGraph (null tot gegenereer). 'n 400 kom terug vir 'n leë input sonder source, 'n misvormde length, of 'n ongeldige aspect, preset, fillMode of language.

Kry 'n verduideliking

Gee die volledige rekord terug: huidige status, die videoUrl sodra ready, die redigeerbare sceneGraph, die weergawegeskiedenis (versions) en die toneel-chunks van die hoofweergawe. 'n Ontbrekende id gee 404 terug.

Lys verduidelikings

Lys die roepende sleutel se verduidelikings, nuutste eerste. Beperk tot die sleuteleienaar. limit word tot 1 tot 100 vasgeklem (verstek 50). Gee ligte opsommings terug (geen scene graph of weergawes nie). Gebruik kry 'n verduideliking vir die volledige rekord.

Redigeer 'n verduideliking

Die redigeerbaarheidswig. Verander 'n instruksie in gewone taal in 'n geteikende her-render. Slegs die geraakte tonele word her-render, wat 'n nuwe weergawe skep. Gee 202 terug met die weergawe in die tou. Poll kry 'n verduideliking totdat die hoofweergawe ready is. Dit voeg by die bestaande video, so dit verbruik nie 'n ekstra gratis-video-skeppingsgleuf nie. Die eerste her-render van elke video is gratis. Latere gebruik betaalde-plan-minute, en gratis rekeninge word gevra om 'n plan te begin. Die verduideliking moet reeds ready wees (anders 409).

{ "instruction": "Make the title scene shorter and warmer" }

Keer terug na 'n weergawe

Wys die kop weer na 'n vroeëre gereed weergawe en weerspieël sy graaf en video na die rekord. Die teiken moet 'n ready-weergawe met 'n video wees (anders 409).

{ "versionId": "..." }

Lewendige statusstroom

'n Server-Sent Events-stroom (text/event-stream). Maak een verbinding oop en elke statusoorgang op enige van jou verduidelikings kom aan as 'n event: status-raam, sodat jy 'n "video gereed"-toestand kan opdateer op die oomblik dat die worker klaar is in plaas van poll. Die stroom is beperk tot jou sleuteleienaar.

Stemme

Die vertelstem-katalogus. Die opsionele ?language=<code> filter na stemme wat inheems is aan daardie taal. Gee voices terug (elk met 'n vriendelike name, die id om as voice deur te gee, language, isDefault en 'n speelbare preview_url) plus die globale default. Sien Stemme.

Tale

Die ondersteunde vertellingstale, as { code, label, native }. Elke code is 'n geldige language by skepping. Sien Tale.

Rekeningstatus

Gee videosGenerated (lewenslank), die rekening se image en isAdmin terug. Vereis stawing.

Faktureringstatus

Vereis stawing en gee 200 terug vir beide gratis en betaalde rekeninge. 'n Gratis rekening gee plan: "free" terug met videoAllowance, videosUsed en videosRemaining. 'n Betaalde rekening gee ook planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining en bonusMinutes terug.

Looptydkonfigurasie en gesondheid

Openbaar. Gee { "authEnforced": true } terug. 'n Lewendigheidskontrole is by GET /health.