Референца за API

Конвенции

Секој endpoint /v1/* бара заглавие Authorization: Bearer sk_.... Грешките се враќаат како JSON со знаменце error и message:

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

Endpoint-ите за генерирање се ограничени на 20 барања во минута. Сите други endpoint-и делат ограничување од 200 во минута.

Создајте објаснување

Започнува генерирање и враќа 202 Accepted со записот во ред. Анкетирајте земи објаснување додека не е ready.

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

Го враќа записот на објаснувањето: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null до подготвеност) и sceneGraph (null до генерирање). 400 се враќа за празен input без source, лошо форматиран length, или невалиден aspect, preset, fillMode или language.

Земи објаснување

Го враќа целосниот запис: тековен status, videoUrl откако е ready, уредливиот sceneGraph, историјата на верзии (versions) и сцените chunks на главната верзија. Недостасувачки id враќа 404.

Листа на објаснувања

Ги листа објаснувањата на повикувачкиот клуч, најнови први. Ограничено на сопственикот на клучот. limit се ограничува од 1 до 100 (стандардно 50). Враќа лесни резимеа (без scene graph или верзии). За целосниот запис користете земи објаснување.

Уреди објаснување

Клинот на уредливоста. Претворете упатство на едноставен јазик во насочено повторно рендерирање. Само засегнатите сцени се рендерираат повторно, создавајќи нова верзија. Враќа 202 со верзијата во ред. Анкетирајте земи објаснување додека главната верзија не е ready. Ова се додава на постојното видео, па не троши уште еден слот за создавање бесплатно видео. Првото повторно рендерирање на секое видео е бесплатно. Подоцнежните користат минути од платен план, а бесплатните сметки се замолуваат да започнат план. Објаснувањето веќе мора да е ready (инаку 409).

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

Врати на верзија

Ја пренасочува главата кон поранешна подготвена верзија и ги отсликува нејзиниот граф и видео на записот. Целта мора да е ready верзија со видео (инаку 409).

{ "versionId": "..." }

Тек на статус во живо

Тек на Server-Sent Events (text/event-stream). Отворете една врска и секој премин на статус на кое било од вашите објаснувања пристигнува како рамка event: status, така што можете да ажурирате состојба "видео подготвено" во моментот кога работникот завршува, наместо анкетирање. Текот е ограничен на сопственикот на вашиот клуч.

Гласови

Каталогот на гласови за раскажување. Изборниот ?language=<code> филтрира на гласови родни за тој јазик. Враќа voices (секој со пријателско name, id за проследување како voice, language, isDefault и репродуцибилен preview_url) плус глобалниот default. Видете Гласови.

Јазици

Поддржаните јазици за раскажување, како { code, label, native }. Секој code е валиден language при создавање. Видете Јазици.

Состојба на сметка

Враќа videosGenerated (доживотно), image на сметката и isAdmin. Бара автентикација.

Статус на наплата

Бара автентикација и враќа 200 и за бесплатни и за платени сметки. Бесплатна сметка враќа plan: "free" со videoAllowance, videosUsed и videosRemaining. Платена сметка враќа и planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining и bonusMinutes.

Конфигурација за извршување и здравје

Јавно. Враќа { "authEnforced": true }. Проверка на живост има на GET /health.