Referència de l’API

Convencions

Cada endpoint /v1/* requereix la capçalera Authorization: Bearer sk_.... Els errors tornen com a JSON amb un indicador error i un message:

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

Els endpoints de generació estan limitats a 20 peticions per minut. Tota la resta d'endpoints comparteixen un límit de 200 per minut.

Crea un explicatiu

Inicia una generació i retorna 202 Accepted amb el registre a la cua. Sondeja obtenir un explicatiu fins que estigui ready.

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

Retorna el registre de l'explicatiu: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null fins que estigui a punt) i sceneGraph (null fins que es generi). Un 400 torna per a un input buit sense source, un length mal format, o un aspect, preset, fillMode o language no vàlid.

Obtenir un explicatiu

Retorna el registre complet: status actual, la videoUrl un cop ready, el sceneGraph editable, l'historial de versions (versions) i els chunks d'escena de la versió principal. Un id que falta retorna 404.

Llistar explicatius

Llista els explicatius de la clau que crida, els més nous primer. Limitat al propietari de la clau. limit es limita d'1 a 100 (per defecte 50). Retorna resums lleugers (sense scene graph ni versions). Per al registre complet useu obtenir un explicatiu.

Editar un explicatiu

La cunya de l'editabilitat. Convertiu una instrucció en llenguatge planer en un re-render dirigit. Només es tornen a renderitzar les escenes afectades, produint una nova versió. Retorna 202 amb la versió a la cua. Sondeja obtenir un explicatiu fins que la versió principal estigui ready. Això s'afegeix al vídeo existent, així que no consumeix una altra creació de vídeo gratuït. El primer re-render de cada vídeo és gratuït. Els següents usen minuts del pla de pagament, i als comptes gratuïts se'ls demana que iniciïn un pla. L'explicatiu ja ha d'estar ready (si no 409).

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

Revertir a una versió

Reapunta el cap a una versió a punt anterior i reflecteix el seu graf i vídeo al registre. L'objectiu ha de ser una versió ready amb un vídeo (si no 409).

{ "versionId": "..." }

Flux d'estat en directe

Un flux de Server-Sent Events (text/event-stream). Obriu una connexió i cada transició d'estat en qualsevol dels vostres explicatius arriba com a un frame event: status, de manera que podeu actualitzar un estat "vídeo a punt" en el moment que el worker acaba en lloc de sondejar. El flux està limitat al propietari de la vostra clau.

Veus

El catàleg de veus de narració. L'opcional ?language=<code> filtra a veus natives d'aquell idioma. Retorna voices (cadascuna amb un name amable, l'id a passar com a voice, language, isDefault i un preview_url reproduïble) més el default global. Vegeu Veus.

Idiomes

Els idiomes de narració admesos, com a { code, label, native }. Cada code és un language vàlid en la creació. Vegeu Idiomes.

Estat del compte

Retorna videosGenerated (de per vida), la image del compte i isAdmin. Requereix autenticació.

Estat de la facturació

Requereix autenticació i retorna 200 tant per a comptes gratuïts com de pagament. Un compte gratuït retorna plan: "free" amb videoAllowance, videosUsed i videosRemaining. Un compte de pagament també retorna planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining i bonusMinutes.

Configuració de temps d'execució i salut

Públic. Retorna { "authEnforced": true }. Una comprovació de vida es troba a GET /health.