Rejeleo la API

Makubaliano

Kila endpoint /v1/* inahitaji kichwa Authorization: Bearer sk_.... Makosa hurudi kama JSON yenye bendera error na message:

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

Endpoint za uzalishaji zimewekewa kikomo cha maombi 20 kwa dakika. Endpoint zingine zote hushiriki kikomo cha 200 kwa dakika.

Tengeneza maelezo

Huanzisha uzalishaji na hurudisha 202 Accepted na rekodi iliyopo kwenye foleni. Uliza pata maelezo hadi iwe ready.

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

Hurudisha rekodi ya maelezo: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null hadi tayari) na sceneGraph (null hadi kuzalishwa). 400 hurudi kwa input tupu bila source, length iliyoharibika, au aspect, preset, fillMode au language isiyo halali.

Pata maelezo

Hurudisha rekodi kamili: status ya sasa, videoUrl mara ready, sceneGraph inayohaririwa, historia ya matoleo (versions) na chunks za tukio za toleo la kichwa. id inayokosekana hurudisha 404.

Orodhesha maelezo

Huorodhesha maelezo ya ufunguo unaopiga simu, mapya kwanza. Imefungwa kwa mmiliki wa ufunguo. limit hufungwa kutoka 1 hadi 100 (chaguo-msingi 50). Hurudisha muhtasari mwepesi (hakuna scene graph au matoleo). Tumia pata maelezo kwa rekodi kamili.

Hariri maelezo

Kabari ya uwezo wa kuhariri. Geuza maagizo ya lugha rahisi kuwa render upya inayolengwa. Matukio yaliyoathiriwa tu ndiyo yanayorendwa upya, yakizalisha toleo jipya. Hurudisha 202 na toleo lililoko kwenye foleni. Uliza pata maelezo hadi toleo la kichwa liwe ready. Hii huongezwa kwenye video iliyopo, hivyo haitumii nafasi nyingine ya kutengeneza video ya bure. Render upya ya kwanza ya kila video ni bure. Zinazofuata hutumia dakika za mpango wa kulipia, na akaunti za bure huombwa kuanzisha mpango. Maelezo lazima tayari yawe ready (vinginevyo 409).

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

Rejesha kwa toleo

Huelekeza kichwa upya kwenye toleo tayari la awali na huakisi grafu na video yake kwenye rekodi. Lengo lazima liwe toleo ready lenye video (vinginevyo 409).

{ "versionId": "..." }

Mkondo wa hali ya moja kwa moja

Mkondo wa Server-Sent Events (text/event-stream). Fungua muunganisho mmoja na kila mpito wa hali kwenye maelezo yako yoyote hufika kama fremu event: status, hivyo unaweza kusasisha hali ya "video tayari" wakati worker anamaliza badala ya kuuliza. Mkondo umefungwa kwa mmiliki wa ufunguo wako.

Sauti

Katalogi ya sauti za usimulizi. ?language=<code> ya hiari huchuja hadi sauti asili za lugha hiyo. Hurudisha voices (kila moja yenye name rafiki, id ya kupitisha kama voice, language, isDefault na preview_url inayochezeka) pamoja na default ya kimataifa. Ona Sauti.

Lugha

Lugha za usimulizi zinazotumika, kama { code, label, native }. Kila code ni language halali wakati wa kutengeneza. Ona Lugha.

Hali ya akaunti

Hurudisha videosGenerated (maisha yote), image ya akaunti na isAdmin. Inahitaji uthibitishaji.

Hali ya bili

Inahitaji uthibitishaji na hurudisha 200 kwa akaunti za bure na za kulipia. Akaunti ya bure hurudisha plan: "free" na videoAllowance, videosUsed na videosRemaining. Akaunti ya kulipia pia hurudisha planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining na bonusMinutes.

Usanidi wa wakati wa utekelezaji na afya

Umma. Hurudisha { "authEnforced": true }. Ukaguzi wa uhai upo kwenye GET /health.