Referensi API

Saben endpoint, karo wangun panjaluk lan wangsulane. Kabeh rute relatif marang https://sketchie.ai/api.

Konvensi

Saben endpoint /v1/* mbutuhake header Authorization: Bearer sk_.... Kesalahan bali minangka JSON kanthi gendera error lan message:

Wangsulan kesalahan

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

Endpoint generasi diwatesi tekan 20 panjaluk saben menit. Kabeh endpoint liyane nuduh watesan 200 saben menit.

Gawe panjelasan

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

Miwiti generasi lan mbalekake 202 Accepted karo rekaman ing antrian. Poll jupuk panjelasan nganti ready.

Awak panjaluk

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

Ruas	Jinis	Cathetan
`input`	string	Apa sing kudu dijlentrehake. Prompt cendhak utawa teks dokumen lengkap. Dibutuhake kajaba `source` utawa `sceneGraph` ana. Alias: `prompt`.
`length`	string or number	Dawa target minangka `"M:SS"` (`"0:30"`, `"1:00"`) utawa detik. Kelipatan positif 30, nganti 360. Ilangi kanggo dawa otomatis. Alias: `lengthSeconds` (angka).
`voice`	string	Opsional. Ref swara. Standar yaiku narator standar (Nora). Deleng Swara.
`language`	string	Opsional. Kode basa sing didhukung (standar `en`). Deleng Basa.
`aspect`	string	Opsional. `16:9` (standar), `9:16`, utawa `1:1`.
`source`	string	Opsional. Dokumen, artikel utawa transkrip sing bakal digawe panjelasan. Yen ana, `input` dadi tuntunan opsional.
`preset`	string	Gaya gambar opsional: `marker` (standar), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Teknik isian pambuka opsional: `A`, `B`, `C` (standar), utawa `D`.
`sceneGraph`	object	Opsional. Scene graph sing wis ditulis sadurunge. Worker ngliwati generasi graf lan ngrender kanthi langsung, nanging endpoint iki isih nggawe panjelasan anyar lan nganggo jatah gratis normal utawa kuota paket mbayar saka sing nelpon. Kanggo nyunting panjelasan sing wis ana, gunakake sunting panjelasan.

Mbalekake rekaman panjelasan: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null nganti siyap) lan sceneGraph (null nganti digawe). 400 bali kanggo input kosong tanpa source, length salah wangun, utawa aspect, preset, fillMode utawa language sing ora valid.

Jupuk panjelasan

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

Mbalekake rekaman lengkap: status saiki, videoUrl nalika ready, sceneGraph sing bisa disunting, sajarah versi (versions) lan chunks adegan versi sirah. id sing ilang mbalekake 404.

Dhaptar panjelasan

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

Ndhaptar panjelasan saka kunci sing nelpon, paling anyar dhisik. Diwatesi marang sing duwe kunci. limit diwatesi saka 1 nganti 100 (standar 50). Mbalekake ringkesan entheng (ora ana scene graph utawa versi). Gunakake jupuk panjelasan kanggo rekaman lengkap.

Sunting panjelasan

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

Baji kabisan disunting. Ganti prentah basa lugu dadi render maneh sing ditargetake. Mung adegan sing kena pengaruh sing dirender maneh, ngasilake versi anyar. Mbalekake 202 karo versi ing antrian. Poll jupuk panjelasan nganti versi sirah ready. Iki ditambahake ing video sing wis ana, dadi ora nganggo slot nggawe video gratis liyane. Render maneh pisanan saben video gratis. Sing sabanjure nganggo menit paket mbayar, lan akun gratis dijaluk miwiti paket. Panjelasan kudu wis ready (yen ora 409).

Awak panjaluk

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

Mbalekake menyang versi

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

Ngarahake maneh sirah menyang versi siyap sadurunge lan nyerminake graf lan videone menyang rekaman. Target kudu versi ready sing duwe video (yen ora 409).

Awak panjaluk

{ "versionId": "..." }

Stream status langsung

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

Stream Server-Sent Events (text/event-stream). Bukak siji sambungan lan saben transisi status ing panjelasan apa wae duwekmu teka minangka pigura event: status, dadi sampeyan bisa nganyari kahanan "video siyap" nalika worker rampung tinimbang polling. Stream diwatesi marang sing duwe kuncimu.

Swara

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

Katalog swara narasi. ?language=<code> opsional nyaring menyang swara asli basa kasebut. Mbalekake voices (saben duwe name ramah, id kanggo dikirim minangka voice, language, isDefault lan preview_url sing bisa diputer) plus default global. Deleng Swara.

Basa

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

Basa narasi sing didhukung, minangka { code, label, native }. Saben code yaiku language sing valid nalika nggawe. Deleng Basa.

Kahanan akun

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

Mbalekake videosGenerated (saumur urip), image akun lan isAdmin. Mbutuhake otentikasi.

Status tagihan

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

Mbutuhake otentikasi lan mbalekake 200 kanggo akun gratis lan mbayar. Akun gratis mbalekake plan: "free" karo videoAllowance, videosUsed lan videosRemaining. Akun mbayar uga mbalekake planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining lan bonusMinutes.

Konfigurasi wektu mlaku lan kesehatan

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

Umum. Mbalekake { "authEnforced": true }. Priksa urip ana ing GET /health.