API tilvísun

Venjur

Hver /v1/* endapunktur krefst Authorization: Bearer sk_... hausins. Villur koma til baka sem JSON með error fána og message:

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

Myndunar-endapunktar eru takmarkaðir við 20 beiðnir á mínútu. Allir aðrir endapunktar deila 200 á mínútu mörkum.

Búa til skýringu

Hefur myndun og skilar 202 Accepted með færslunni í biðröð. Pollaðu sækja skýringu þar til hún er ready.

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

Skilar skýringarfærslunni: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null þar til tilbúið) og sceneGraph (null þar til myndað). 400 kemur til baka fyrir tómt input án source, gölluð length, eða ógilt aspect, preset, fillMode eða language.

Sækja skýringu

Skilar allri færslunni: núverandi status, videoUrl þegar ready, breytanlegur sceneGraph, útgáfusaga (versions) og senu-chunks aðalútgáfunnar. Vantandi id skilar 404.

Lista skýringar

Listar skýringar kallandi lykilsins, nýjustu fyrst. Takmarkað við eiganda lykilsins. limit er klemmt við 1 til 100 (sjálfgefið 50). Skilar léttum samantektum (enginn scene graph eða útgáfur). Fyrir alla færsluna notaðu sækja skýringu.

Breyta skýringu

Fleygur breytanleikans. Breyttu fyrirmælum á venjulegu máli í markvissa endurmyndun. Aðeins áhrifasenur eru endurmyndaðar, sem framleiðir nýja útgáfu. Skilar 202 með útgáfunni í biðröð. Pollaðu sækja skýringu þar til aðalútgáfan er ready. Þetta bætist við núverandi myndband, svo það notar ekki annað ókeypis-myndbands sköpunarpláss. Fyrsta endurmyndun hvers myndbands er ókeypis. Síðari nota greiddar-áskriftar mínútur og ókeypis reikningar eru beðnir um að hefja áskrift. Skýringin verður þegar að vera ready (annars 409).

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

Afturkalla í útgáfu

Beinir hausnum aftur að fyrri tilbúinni útgáfu og speglar graf hennar og myndband í færsluna. Markmiðið verður að vera ready útgáfa með myndbandi (annars 409).

{ "versionId": "..." }

Beinn stöðustraumur

Server-Sent Events straumur (text/event-stream). Opnaðu eina tengingu og hver stöðubreyting á hvaða skýringu þinna kemur sem event: status rammi, svo þú getur uppfært "myndband tilbúið" ástand á því augnabliki sem verkamaðurinn lýkur í stað þess að polla. Straumurinn er takmarkaður við eiganda lykilsins þíns.

Raddir

Sögumannsradda-skráin. Valfrjálst ?language=<code> síar á raddir sem eru innfæddar því tungumáli. Skilar voices (hver með vinalegu name, id til að senda sem voice, language, isDefault og spilanlegu preview_url) auk hnattræna default. Sjá Raddir.

Tungumál

Studd sögumannstungumál, sem { code, label, native }. Hver code er gilt language við gerð. Sjá Tungumál.

Reikningsstaða

Skilar videosGenerated (ævilangt), image reikningsins og isAdmin. Krefst auðkenningar.

Reikningsfærslustaða

Krefst auðkenningar og skilar 200 fyrir bæði ókeypis og greidda reikninga. Ókeypis reikningur skilar plan: "free" með videoAllowance, videosUsed og videosRemaining. Greiddur reikningur skilar einnig planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining og bonusMinutes.

Keyrslutíma stilling og heilsa

Opinbert. Skilar { "authEnforced": true }. Lífsathugun er á GET /health.