API referansı

Kurallar

Her /v1/* uç noktası Authorization: Bearer sk_... başlığını gerektirir. Hatalar bir error bayrağı ve message ile JSON olarak geri döner:

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

Üretim uç noktaları dakikada 20 istekle sınırlıdır. Diğer tüm uç noktalar dakikada 200 sınırını paylaşır.

Bir anlatım oluştur

Bir üretim başlatır ve kuyruğa alınmış kayıtla 202 Accepted döndürür. ready olana kadar bir anlatım al yoklayın.

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

Anlatım kaydını döndürür: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (hazır olana kadar null) ve sceneGraph (üretilene kadar null). Source olmadan boş bir input, hatalı biçimlendirilmiş length veya geçersiz aspect, preset, fillMode ya da language için 400 döner.

Bir anlatım al

Tam kaydı döndürür: geçerli status, ready olduğunda videoUrl, düzenlenebilir sceneGraph, sürüm geçmişi (versions) ve baş sürümün sahne chunks. Eksik bir id 404 döner.

Anlatımları listele

Çağıran anahtarın anlatımlarını, en yeniden başlayarak listeler. Anahtarın sahibiyle sınırlıdır. limit 1 ile 100 arasına sıkıştırılır (varsayılan 50). Hafif özetler döndürür (scene graph veya sürüm yok). Tam kayıt için bir anlatım al kullanın.

Bir anlatımı düzenle

Düzenlenebilirlik kaması. Düz dilde bir talimatı hedeflenmiş bir yeniden render işlemine dönüştürün. Yalnızca etkilenen sahneler yeniden render edilir ve yeni bir sürüm üretilir. Kuyruğa alınmış sürümle 202 döndürür. Baş sürüm ready olana kadar bir anlatım al yoklayın. Bu, mevcut videoya eklenir, bu yüzden başka bir ücretsiz video oluşturma yuvası tüketmez. Her videonun ilk yeniden render işlemi ücretsizdir. Sonrakiler ücretli plan dakikalarını kullanır ve ücretsiz hesaplardan bir plan başlatmaları istenir. Anlatım zaten ready olmalıdır (aksi halde 409).

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

Bir sürüme geri dön

Başı daha önceki hazır bir sürüme yeniden yönlendirir ve onun grafiğini ve videosunu kayda yansıtır. Hedef, videosu olan bir ready sürümü olmalıdır (aksi halde 409).

{ "versionId": "..." }

Canlı durum akışı

Bir Server-Sent Events akışı (text/event-stream). Bir bağlantı açın ve anlatımlarınızdan herhangi birindeki her durum geçişi bir event: status çerçevesi olarak gelir, böylece yoklama yerine işçi bittiği anda "video hazır" durumunu güncelleyebilirsiniz. Akış anahtarınızın sahibiyle sınırlıdır.

Sesler

Anlatım sesi kataloğu. İsteğe bağlı ?language=<code> o dile ana olan seslere filtreler. voices (her biri kullanıcı dostu bir name, voice olarak geçirilecek id, language, isDefault ve oynatılabilir bir preview_url ile) artı genel default döndürür. Bkz. Sesler.

Diller

Desteklenen anlatım dilleri, { code, label, native } olarak. Her code oluşturmada geçerli bir language. Bkz. Diller.

Hesap durumu

videosGenerated (ömür boyu), hesabın image'ını ve isAdmin'i döndürür. Kimlik doğrulama gerektirir.

Fatura durumu

Kimlik doğrulama gerektirir ve hem ücretsiz hem ücretli hesaplar için 200 döndürür. Ücretsiz bir hesap videoAllowance, videosUsed ve videosRemaining ile plan: "free" döndürür. Ücretli bir hesap ayrıca planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining ve bonusMinutes döndürür.

Çalışma zamanı yapılandırması ve sağlık

Genel. { "authEnforced": true } döndürür. Bir canlılık kontrolü GET /health adresindedir.