Reference API

Každý endpoint s tvarem jeho požadavku a odpovědi. Všechny cesty jsou relativní k https://sketchie.ai/api.

Konvence

Každý endpoint /v1/* vyžaduje hlavičku Authorization: Bearer sk_.... Chyby se vracejí jako JSON s příznakem error a message:

Chybová odpověď

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

Endpointy generování jsou omezeny na 20 požadavků za minutu. Všechny ostatní endpointy sdílejí limit 200 za minutu.

Vytvořit vysvětlení

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

Spustí generování a vrátí 202 Accepted se záznamem ve frontě. Dotazujte se na získat vysvětlení, dokud není ready.

Tělo požadavku

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

Pole	Typ	Poznámky
`input`	string	Co vysvětlit. Krátký prompt nebo celý text dokumentu. Vyžadováno, pokud není přítomen `source` nebo `sceneGraph`. Alias: `prompt`.
`length`	string or number	Cílová délka jako `"M:SS"` (`"0:30"`, `"1:00"`) nebo sekundy. Kladný násobek 30, až 360. Vynechte pro automatickou délku. Alias: `lengthSeconds` (číslo).
`voice`	string	Volitelné. Reference hlasu. Výchozí standardní vypravěč (Nora). Viz Hlasy.
`language`	string	Volitelné. Podporovaný kód jazyka (výchozí `en`). Viz Jazyky.
`aspect`	string	Volitelné. `16:9` (výchozí), `9:16`, nebo `1:1`.
`source`	string	Volitelné. Dokument, článek nebo přepis k přeměně na vysvětlení. Když je přítomen, `input` se stane volitelným vodítkem.
`preset`	string	Volitelný styl kreslení: `marker` (výchozí), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Volitelná technika výplně odhalení: `A`, `B`, `C` (výchozí), nebo `D`.
`sceneGraph`	object	Volitelné. Předem napsaný scene graph. Worker přeskočí generování grafu a vyrenderuje jej přímo, ale tento endpoint stále vytváří nové vysvětlení a spotřebovává běžnou bezplatnou kvótu nebo kvótu placeného plánu volajícího. Chcete-li upravit existující vysvětlení, použijte upravit vysvětlení.

Vrací záznam vysvětlení: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null do připravení) a sceneGraph (null do vygenerování). 400 se vrací pro prázdný input bez source, chybně formátovanou length, nebo neplatný aspect, preset, fillMode či language.

Získat vysvětlení

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

Vrací celý záznam: aktuální status, videoUrl jakmile ready, upravitelný sceneGraph, historii verzí (versions) a scénové chunks hlavní verze. Chybějící id vrací 404.

Vypsat vysvětlení

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

Vypíše vysvětlení volajícího klíče, nejnovější první. Omezeno na vlastníka klíče. limit je omezen na 1 až 100 (výchozí 50). Vrací lehká shrnutí (bez scene graph nebo verzí). Pro celý záznam použijte získat vysvětlení.

Upravit vysvětlení

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

Klín upravitelnosti. Proměňte pokyn v prostém jazyce v cílené přerenderování. Přerenderují se pouze zasažené scény, čímž vznikne nová verze. Vrací 202 s verzí ve frontě. Dotazujte se na získat vysvětlení, dokud hlavní verze není ready. Toto se připojuje ke stávajícímu videu, takže nespotřebovává další slot pro vytvoření bezplatného videa. První přerenderování každého videa je zdarma. Pozdější používají minuty placeného plánu a bezplatné účty jsou požádány, aby zahájily plán. Vysvětlení už musí být ready (jinak 409).

Tělo požadavku

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

Vrátit na verzi

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

Přesměruje hlavu na dřívější připravenou verzi a zrcadlí její graf a video na záznam. Cíl musí být verze ready s videem (jinak 409).

Tělo požadavku

{ "versionId": "..." }

Živý stream stavu

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

Stream Server-Sent Events (text/event-stream). Otevřete jedno připojení a každý přechod stavu na kterémkoli z vašich vysvětlení dorazí jako rámec event: status, takže můžete aktualizovat stav "video připraveno" v okamžiku, kdy worker dokončí, místo dotazování. Stream je omezen na vlastníka vašeho klíče.

Hlasy

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

Katalog vyprávěcích hlasů. Volitelný ?language=<code> filtruje na hlasy nativní pro daný jazyk. Vrací voices (každý s přívětivým name, id k předání jako voice, language, isDefault a přehratelnou preview_url) plus globální default. Viz Hlasy.

Jazyky

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

Podporované vyprávěcí jazyky jako { code, label, native }. Každý code je platný language při vytváření. Viz Jazyky.

Stav účtu

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

Vrací videosGenerated (za celý život), image účtu a isAdmin. Vyžaduje ověření.

Stav fakturace

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

Vyžaduje ověření a vrací 200 pro bezplatné i placené účty. Bezplatný účet vrací plan: "free" s videoAllowance, videosUsed a videosRemaining. Placený účet vrací také planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining a bonusMinutes.

Konfigurace za běhu a stav

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

Veřejné. Vrací { "authEnforced": true }. Kontrola živosti je na GET /health.