Справочник за 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.