API istinadı

Hər endpoint, onun sorğu və cavab forması ilə. Bütün marşrutlar https://sketchie.ai/api-ə nisbətəndir.

Konvensiyalar

Hər /v1/* endpoint Authorization: Bearer sk_... başlığı tələb edir. Xətalar error bayrağı və message ilə JSON kimi qayıdır:

Xəta cavabı

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

Generasiya endpoint-ləri dəqiqədə 20 sorğu ilə məhdudlaşdırılır. Bütün digər endpoint-lər dəqiqədə 200 limitini paylaşır.

İzahat yaradın

POST https://sketchie.ai/api/v1/explainer

Generasiyanı başladır və növbədə olan qeydlə 202 Accepted qaytarır. ready olana qədər izahat alın-ı poll edin.

Sorğu gövdəsi

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

Sahə	Növ	Qeydlər
`input`	string	Nəyi izah etmək. Qısa prompt və ya tam sənəd mətni. `source` və ya `sceneGraph` olmadıqda tələb olunur. Ləqəb: `prompt`.
`length`	string or number	Hədəf uzunluğu `"M:SS"` (`"0:30"`, `"1:00"`) və ya saniyə kimi. 30-un müsbət qatı, 360-a qədər. Avtomatik uzunluq üçün buraxın. Ləqəb: `lengthSeconds` (rəqəm).
`voice`	string	İstəyə bağlı. Səs ref. Standart danışan (Nora) standartdır. Səslər bax.
`language`	string	İstəyə bağlı. Dəstəklənən dil kodu (standart `en`). Dillər bax.
`aspect`	string	İstəyə bağlı. `16:9` (standart), `9:16`, və ya `1:1`.
`source`	string	İstəyə bağlı. İzahata çevirmək üçün sənəd, məqalə və ya transkript. Mövcud olduqda, `input` istəyə bağlı təlimata çevrilir.
`preset`	string	İstəyə bağlı çəkiliş üslubu: `marker` (standart), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	İstəyə bağlı açılış doldurma texnikası: `A`, `B`, `C` (standart), və ya `D`.
`sceneGraph`	object	İstəyə bağlı. Əvvəlcədən yazılmış scene graph. İşçi qraf generasiyasını atlayır və onu birbaşa render edir, lakin bu endpoint hələ də yeni izahat yaradır və zəng edənin normal pulsuz kvotasını və ya ödənişli-plan kvotasını istifadə edir. Mövcud izahatı redaktə etmək üçün izahatı redaktə edin istifadə edin.

İzahat qeydini qaytarır: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (hazır olana qədər null) və sceneGraph (generasiya olana qədər null). source olmayan boş input, səhv formatlı length, və ya etibarsız aspect, preset, fillMode və ya language üçün 400 qayıdır.

İzahat alın

GET https://sketchie.ai/api/v1/explainer/:id

Tam qeydi qaytarır: cari status, ready olduqda videoUrl, redaktə edilə bilən sceneGraph, versiya tarixçəsi (versions) və baş versiyanın səhnə chunks. Çatışmayan id 404 qaytarır.

İzahatları siyahıya alın

GET https://sketchie.ai/api/v1/explainer?limit=50

Zəng edən açarın izahatlarını, ən yenilər əvvəl, siyahıya alır. Açar sahibinə məhdudlaşdırılıb. limit 1-dən 100-ə qədər sıxılır (standart 50). Yüngül xülasələr qaytarır (scene graph və ya versiyalar yoxdur). Tam qeyd üçün izahat alın istifadə edin.

İzahatı redaktə edin

POST https://sketchie.ai/api/v1/explainer/:id/edit

Redaktə edilə bilmə paçkası. Sadə dildə təlimatı hədəflənmiş yenidən render-ə çevirin. Yalnız təsirlənən səhnələr yenidən render olunur, yeni versiya yaradır. Növbədə olan versiya ilə 202 qaytarır. Baş versiya ready olana qədər izahat alın-ı poll edin. Bu, mövcud videoya əlavə olunur, ona görə başqa pulsuz-video yaratma yeri istifadə etmir. Hər videonun ilk yenidən render-i pulsuzdur. Sonrakılar ödənişli-plan dəqiqələri istifadə edir və pulsuz hesablardan plan başlatmaları xahiş olunur. İzahat artıq ready olmalıdır (əks halda 409).

Sorğu gövdəsi

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

Bir versiyaya qaytarın

POST https://sketchie.ai/api/v1/explainer/:id/revert

Başı əvvəlki hazır versiyaya yenidən yönləndirir və onun qrafını və videosunu qeydə əks etdirir. Hədəf videosu olan ready versiya olmalıdır (əks halda 409).

Sorğu gövdəsi

{ "versionId": "..." }

Canlı status axını

GET https://sketchie.ai/api/v1/explainer/events

Server-Sent Events axını (text/event-stream). Bir bağlantı açın və izahatlarınızdan hər hansı biri üzərindəki hər status keçidi event: status çərçivəsi kimi gəlir, beləliklə poll etmək əvəzinə işçi bitirdiyi anda "video hazır" vəziyyətini yeniləyə bilərsiniz. Axın açarınızın sahibinə məhdudlaşdırılıb.

Səslər

GET https://sketchie.ai/api/v1/voices

Nağıl səsləri kataloqu. İstəyə bağlı ?language=<code> o dilə doğma səslərə filtrləyir. voices qaytarır (hər biri rahat name, voice kimi ötürmək üçün id, language, isDefault və oynadıla bilən preview_url ilə) plus qlobal default. Səslər bax.

Dillər

GET https://sketchie.ai/api/v1/languages

Dəstəklənən nağıl dilləri, { code, label, native } kimi. Hər code yaratmada etibarlı language-dir. Dillər bax.

Hesab vəziyyəti

GET https://sketchie.ai/api/v1/account/state

videosGenerated (ömür boyu), hesab image-i və isAdmin qaytarır. Autentifikasiya tələb edir.

Faktura statusu

GET https://sketchie.ai/api/v1/billing/status

Autentifikasiya tələb edir və həm pulsuz, həm ödənişli hesablar üçün 200 qaytarır. Pulsuz hesab videoAllowance, videosUsed və videosRemaining ilə plan: "free" qaytarır. Ödənişli hesab həmçinin planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining və bonusMinutes qaytarır.

İş vaxtı konfiqurasiyası və sağlamlıq

GET https://sketchie.ai/api/config

İctimai. { "authEnforced": true } qaytarır. Canlılıq yoxlaması GET /health-də yerləşir.