API referencia

Minden végpont, a kérés és válasz formájával. Minden útvonal a https://sketchie.ai/api-hoz viszonyított.

Konvenciók

Minden /v1/* végpont igényli az Authorization: Bearer sk_... fejlécet. A hibák JSON-ként térnek vissza egy error jelzővel és egy message-dzsel:

Hibaválasz

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

A generálási végpontok percenként 20 kérésre vannak korlátozva. Minden más végpont egy percenkénti 200-as korláton osztozik.

Hozz létre magyarázót

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

Elindít egy generálást és 202 Accepted választ ad a sorba állított rekorddal. Kérdezd le a magyarázó lekérése-t, amíg ready nem lesz.

Kérés törzse

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

Mező	Típus	Megjegyzések
`input`	string	Mit magyarázzon. Egy rövid prompt vagy teljes dokumentumszöveg. Kötelező, hacsak nincs jelen `source` vagy `sceneGraph`. Álnév: `prompt`.
`length`	string or number	Célhossz `"M:SS"` (`"0:30"`, `"1:00"`) vagy másodperc formában. A 30 pozitív többszöröse, legfeljebb 360. Hagyd el az automatikus hosszhoz. Álnév: `lengthSeconds` (szám).
`voice`	string	Opcionális. Egy hanghivatkozás. Alapértelmezés a standard narrátor (Nora). Lásd Hangok.
`language`	string	Opcionális. Egy támogatott nyelvkód (alapértelmezés `en`). Lásd Nyelvek.
`aspect`	string	Opcionális. `16:9` (alapértelmezés), `9:16`, vagy `1:1`.
`source`	string	Opcionális. Egy dokumentum, cikk vagy átirat, amelyet magyarázóvá kell alakítani. Jelenléte esetén az `input` opcionális útmutatássá válik.
`preset`	string	Opcionális rajzstílus: `marker` (alapértelmezés), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Opcionális felfedés-kitöltési technika: `A`, `B`, `C` (alapértelmezés), vagy `D`.
`sceneGraph`	object	Opcionális. Egy előre megírt scene graph. A worker kihagyja a gráfgenerálást és közvetlenül rendereli, de ez a végpont még mindig új magyarázót hoz létre, és felhasználja a hívó normál ingyenes keretét vagy fizetős csomag kvótáját. Meglévő magyarázó szerkesztéséhez használd a magyarázó szerkesztése-t.

Visszaadja a magyarázó rekordot: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null a készenlétig) és sceneGraph (null a generálásig). 400 tér vissza source nélküli üres inputra, hibás length-re, vagy érvénytelen aspect, preset, fillMode vagy language esetén.

Magyarázó lekérése

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

Visszaadja a teljes rekordot: aktuális status, a videoUrl amint ready, a szerkeszthető sceneGraph, a verzióelőzmények (versions) és a fej verzió jelenet-chunks-jai. Hiányzó id 404-et ad.

Magyarázók listázása

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

Listázza a hívó kulcs magyarázóit, legújabbak elöl. A kulcs tulajdonosára korlátozva. A limit 1 és 100 közé van szorítva (alapértelmezés 50). Könnyű összefoglalókat ad vissza (nincs scene graph vagy verzió). A teljes rekordhoz használd a magyarázó lekérése-t.

Magyarázó szerkesztése

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

A szerkeszthetőség éke. Alakíts egy egyszerű nyelvű utasítást célzott újrarendereléssé. Csak az érintett jelenetek renderelődnek újra, egy új verziót hozva létre. 202-t ad vissza a sorba állított verzióval. Kérdezd le a magyarázó lekérése-t, amíg a fej verzió ready nem lesz. Ez a meglévő videóhoz fűződik hozzá, így nem használ fel egy másik ingyenes-videó létrehozási helyet. Minden videó első újrarenderelése ingyenes. A későbbiek fizetős csomag perceket használnak, és az ingyenes fiókokat egy csomag indítására kérik. A magyarázónak már ready-nek kell lennie (különben 409).

Kérés törzse

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

Visszaállítás egy verzióra

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

A fejet egy korábbi kész verzióra irányítja át, és annak gráfját és videóját tükrözi a rekordra. A célnak egy videóval rendelkező ready verziónak kell lennie (különben 409).

Kérés törzse

{ "versionId": "..." }

Élő állapotfolyam

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

Egy Server-Sent Events folyam (text/event-stream). Nyiss egy kapcsolatot, és bármelyik magyarázódon minden állapotátmenet event: status keretként érkezik, így frissíthetsz egy "videó kész" állapotot abban a pillanatban, amikor a worker befejezi, ahelyett hogy lekérdeznél. A folyam a kulcsod tulajdonosára van korlátozva.

Hangok

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

A narrációs hangkatalógus. Az opcionális ?language=<code> az adott nyelvhez natív hangokra szűr. Visszaadja a voices-t (mindegyik egy barátságos name-mel, a voice-ként átadandó id-vel, language, isDefault és lejátszható preview_url) plusz a globális default-ot. Lásd Hangok.

Nyelvek

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

A támogatott narrációs nyelvek { code, label, native } formában. Minden code érvényes language létrehozáskor. Lásd Nyelvek.

Fiók állapota

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

Visszaadja a videosGenerated-et (élettartam), a fiók image-ét és az isAdmin-t. Hitelesítést igényel.

Számlázási állapot

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

Hitelesítést igényel és 200-at ad vissza mind ingyenes, mind fizetős fiókoknak. Egy ingyenes fiók plan: "free"-t ad vissza videoAllowance, videosUsed és videosRemaining értékekkel. Egy fizetős fiók planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining és bonusMinutes értékeket is visszaad.

Futásidejű konfiguráció és egészség

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

Nyilvános. Visszaadja a { "authEnforced": true }-t. Egy életképesség-ellenőrzés a GET /health címen található.