Reperensya sa API

Mga kombensyon

Matag /v1/* endpoint nanginahanglan sa Authorization: Bearer sk_... header. Ang mga error mobalik isip JSON nga adunay error flag ug usa ka message:

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

Ang mga generation endpoint gilimitahan sa 20 ka request kada minuto. Ang tanan nga ubang endpoint nagbahin sa limit nga 200 kada minuto.

Paghimo og explainer

Magsugod og generation ug mobalik og 202 Accepted uban sa naka-queue nga record. I-poll ang pagkuha og explainer hangtod nga ready.

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

Mobalik sa record sa explainer: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null hangtod andam) ug sceneGraph (null hangtod ma-generate). Mobalik ang 400 para sa walay sulod nga input nga walay source, sayop nga porma nga length, o dili balido nga aspect, preset, fillMode o language.

Pagkuha og explainer

Mobalik sa bug-os nga record: kasamtangan nga status, ang videoUrl kung ready, ang ma-edit nga sceneGraph, ang kasaysayan sa bersyon (versions) ug ang scene chunks sa head nga bersyon. Ang nawala nga id mobalik og 404.

Ilista ang mga explainer

Naglista sa mga explainer sa tumatawag nga key, pinakabag-o una. Naka-scope sa tag-iya sa key. Ang limit gilimitahan gikan sa 1 hangtod 100 (default 50). Mobalik og gaan nga mga summary (walay scene graph o mga bersyon). Gamita ang pagkuha og explainer para sa bug-os nga record.

Pag-edit og explainer

Ang wedge sa pagka-editable. Himoa ang usa ka instruksyon sa yano nga pinulongan ngadto sa usa ka target nga re-render. Ang mga apektadong eksena lamang ang i-render pag-usab, nga naghimo og bag-ong bersyon. Mobalik og 202 uban sa naka-queue nga bersyon. I-poll ang pagkuha og explainer hangtod nga ang head nga bersyon ready. Kini idugang sa umiiral nga video, mao nga wala kini mogamit og laing libre-video nga slot sa paghimo. Ang unang re-render sa matag video libre. Ang mga sunod naggamit og paid-plan nga minuto, ug ang mga libre nga account gihangyo nga magsugod og plano. Ang explainer kinahanglan nga ready na (kondili 409).

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

Ibalik sa usa ka bersyon

Gitudlo pag-usab ang head sa usa ka nauna nga andam nga bersyon ug gisalamin ang graph ug video niini ngadto sa record. Ang target kinahanglan nga usa ka ready nga bersyon nga adunay video (kondili 409).

{ "versionId": "..." }

Live status stream

Usa ka Server-Sent Events stream (text/event-stream). Pag-abli og usa ka koneksyon ug matag transisyon sa status sa bisan asa sa imong mga explainer moabot isip usa ka event: status frame, aron ma-update mo ang usa ka "video ready" nga kahimtang sa higayon nga mahuman ang worker imbes nga mag-poll. Ang stream naka-scope sa tag-iya sa imong key.

Mga tingog

Ang catalog sa mga tingog sa pagsaysay. Ang opsyonal nga ?language=<code> nag-filter sa mga tingog nga lumad niana nga pinulongan. Mobalik og voices (matag usa adunay mahigalaon nga name, ang id nga ipasa isip voice, language, isDefault ug usa ka mapatokar nga preview_url) dugang sa global nga default. Tan-awa ang Mga tingog.

Mga pinulongan

Ang mga gisuportahan nga pinulongan sa pagsaysay, isip { code, label, native }. Matag code usa ka balido nga language sa paghimo. Tan-awa ang Mga pinulongan.

Kahimtang sa account

Mobalik og videosGenerated (tibuok kinabuhi), ang image sa account ug isAdmin. Nanginahanglan og authentication.

Status sa billing

Nanginahanglan og authentication ug mobalik og 200 para sa libre ug bayad nga mga account. Ang libre nga account mobalik og plan: "free" uban sa videoAllowance, videosUsed ug videosRemaining. Ang bayad nga account mobalik usab og planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining ug bonusMinutes.

Runtime config ug panglawas

Publiko. Mobalik og { "authEnforced": true }. Usa ka liveness check anaa sa GET /health.