Rujukan API
Setiap endpoint, dengan bentuk permintaan dan responsnya. Semua laluan adalah relatif kepada https://sketchie.ai/api.
Konvensyen
Setiap endpoint /v1/* memerlukan pengepala Authorization: Bearer sk_.... Ralat kembali sebagai JSON dengan bendera error dan satu message:
{
"error": true,
"message": "length must be a positive multiple of 30 seconds, at most 360"
}Endpoint penjanaan dihadkan kadar kepada 20 permintaan seminit. Semua endpoint lain berkongsi had 200 seminit.
Cipta penerang
https://sketchie.ai/api/v1/explainer Memulakan penjanaan dan mengembalikan 202 Accepted dengan rekod dalam baris gilir. Tinjau dapatkan penerang sehingga ia ready.
{
"input": "Explain how DNS resolves a domain name",
"length": "0:30",
"aspect": "16:9",
"voice": "sketchie:sulafat",
"language": "en"
}| Medan | Jenis | Nota |
|---|---|---|
input | string | Apa yang hendak diterangkan. Prompt pendek atau teks dokumen penuh. Diperlukan melainkan source atau sceneGraph hadir. Alias: prompt. |
length | string or number | Panjang sasaran sebagai "M:SS" ("0:30", "1:00") atau saat. Gandaan positif 30, sehingga 360. Tinggalkan untuk panjang automatik. Alias: lengthSeconds (nombor). |
voice | string | Pilihan. Satu ref suara. Lalai ialah pencerita standard (Nora). Lihat Suara. |
language | string | Pilihan. Kod bahasa yang disokong (lalai en). Lihat Bahasa. |
aspect | string | Pilihan. 16:9 (lalai), 9:16, atau 1:1. |
source | string | Pilihan. Dokumen, artikel atau transkrip untuk dijadikan penerang. Apabila hadir, input menjadi panduan pilihan. |
preset | string | Gaya lukisan pilihan: marker (lalai), chalkboard, pencil, blueprint, crayon, clean. |
fillMode | string | Teknik isian pendedahan pilihan: A, B, C (lalai), atau D. |
sceneGraph | object | Pilihan. Scene graph yang ditulis terlebih dahulu. Worker melangkau penjanaan graf dan merendernya secara langsung, tetapi endpoint ini masih mencipta penerang baharu dan menggunakan peruntukan percuma biasa atau kuota pelan berbayar pemanggil. Untuk menyunting penerang sedia ada, gunakan sunting penerang. |
Mengembalikan rekod penerang: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null sehingga sedia) dan sceneGraph (null sehingga dijana). 400 kembali untuk input kosong tanpa source, length cacat, atau aspect, preset, fillMode atau language tidak sah.
Dapatkan penerang
https://sketchie.ai/api/v1/explainer/:id Mengembalikan rekod penuh: status semasa, videoUrl apabila ready, sceneGraph boleh sunting, sejarah versi (versions) dan chunks adegan versi kepala. id yang hilang mengembalikan 404.
Senaraikan penerang
https://sketchie.ai/api/v1/explainer?limit=50 Menyenaraikan penerang bagi kunci pemanggil, terbaharu dahulu. Terhad kepada pemilik kunci. limit dihadkan dari 1 hingga 100 (lalai 50). Mengembalikan ringkasan ringan (tiada scene graph atau versi). Gunakan dapatkan penerang untuk rekod penuh.
Sunting penerang
https://sketchie.ai/api/v1/explainer/:id/edit Baji kebolehsuntingan. Tukar arahan bahasa mudah kepada render semula bersasar. Hanya adegan yang terjejas dirender semula, menghasilkan versi baharu. Mengembalikan 202 dengan versi dalam baris gilir. Tinjau dapatkan penerang sehingga versi kepala ready. Ini menambah pada video sedia ada, jadi tidak menggunakan slot penciptaan video percuma yang lain. Render semula pertama setiap video adalah percuma. Yang kemudian menggunakan minit pelan berbayar, dan akaun percuma diminta memulakan pelan. Penerang mesti sudah ready (jika tidak 409).
{ "instruction": "Make the title scene shorter and warmer" }Pulih ke versi
https://sketchie.ai/api/v1/explainer/:id/revert Menghala semula kepala ke versi sedia sebelumnya dan mencerminkan graf dan videonya ke rekod. Sasaran mesti versi ready dengan video (jika tidak 409).
{ "versionId": "..." }Strim status langsung
https://sketchie.ai/api/v1/explainer/events Strim Server-Sent Events (text/event-stream). Buka satu sambungan dan setiap peralihan status pada mana-mana penerang anda tiba sebagai bingkai event: status, jadi anda boleh mengemas kini keadaan "video sedia" pada saat worker selesai dan bukannya meninjau. Strim terhad kepada pemilik kunci anda.
Suara
https://sketchie.ai/api/v1/voices Katalog suara naratif. ?language=<code> pilihan menapis kepada suara natif bahasa itu. Mengembalikan voices (setiap satu dengan name mesra, id untuk dihantar sebagai voice, language, isDefault dan preview_url boleh main) serta default global. Lihat Suara.
Bahasa
https://sketchie.ai/api/v1/languages Bahasa naratif yang disokong, sebagai { code, label, native }. Setiap code ialah language yang sah semasa penciptaan. Lihat Bahasa.
Keadaan akaun
https://sketchie.ai/api/v1/account/state Mengembalikan videosGenerated (seumur hidup), image akaun dan isAdmin. Memerlukan pengesahan.
Status pengebilan
https://sketchie.ai/api/v1/billing/status Memerlukan pengesahan dan mengembalikan 200 untuk akaun percuma dan berbayar. Akaun percuma mengembalikan plan: "free" dengan videoAllowance, videosUsed dan videosRemaining. Akaun berbayar juga mengembalikan planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining dan bonusMinutes.
Konfigurasi masa jalan dan kesihatan
https://sketchie.ai/api/config Awam. Mengembalikan { "authEnforced": true }. Pemeriksaan kehidupan berada di GET /health.