Referencia API

Každý endpoint s tvarom jeho požiadavky a odpovede. Všetky cesty sú relatívne k https://sketchie.ai/api.

Konvencie

Každý endpoint /v1/* vyžaduje hlavičku Authorization: Bearer sk_.... Chyby sa vracajú ako JSON s príznakom error a message:

Chybová odpoveď

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

Endpointy generovania sú obmedzené na 20 požiadaviek za minútu. Všetky ostatné endpointy zdieľajú limit 200 za minútu.

Vytvoriť vysvetlenie

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

Spustí generovanie a vráti 202 Accepted so záznamom vo fronte. Dopytujte sa na získať vysvetlenie, kým nie je ready.

Telo požiadavky

{
  "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	Čo vysvetliť. Krátky prompt alebo celý text dokumentu. Vyžadované, ak nie je prítomný `source` alebo `sceneGraph`. Alias: `prompt`.
`length`	string or number	Cieľová dĺžka ako `"M:SS"` (`"0:30"`, `"1:00"`) alebo sekundy. Kladný násobok 30, až 360. Vynechajte pre automatickú dĺžku. Alias: `lengthSeconds` (číslo).
`voice`	string	Voliteľné. Referencia hlasu. Predvolený štandardný rozprávač (Nora). Pozri Hlasy.
`language`	string	Voliteľné. Podporovaný kód jazyka (predvolený `en`). Pozri Jazyky.
`aspect`	string	Voliteľné. `16:9` (predvolené), `9:16`, alebo `1:1`.
`source`	string	Voliteľné. Dokument, článok alebo prepis na premenu na vysvetlenie. Keď je prítomný, `input` sa stane voliteľným usmernením.
`preset`	string	Voliteľný štýl kreslenia: `marker` (predvolený), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Voliteľná technika výplne odhalenia: `A`, `B`, `C` (predvolené), alebo `D`.
`sceneGraph`	object	Voliteľné. Vopred napísaný scene graph. Worker preskočí generovanie grafu a vyrenderuje ho priamo, ale tento endpoint stále vytvára nové vysvetlenie a spotrebúva bežnú bezplatnú kvótu alebo kvótu plateného plánu volajúceho. Na úpravu existujúceho vysvetlenia použite upraviť vysvetlenie.

Vracia záznam vysvetlenia: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null do pripravenia) a sceneGraph (null do vygenerovania). 400 sa vracia pre prázdny input bez source, chybne naformátovanú length, alebo neplatný aspect, preset, fillMode či language.

Získať vysvetlenie

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

Vracia celý záznam: aktuálny status, videoUrl keď ready, upraviteľný sceneGraph, históriu verzií (versions) a scénové chunks hlavnej verzie. Chýbajúce id vracia 404.

Vypísať vysvetlenia

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

Vypíše vysvetlenia volajúceho kľúča, najnovšie prvé. Obmedzené na vlastníka kľúča. limit je obmedzený na 1 až 100 (predvolené 50). Vracia ľahké súhrny (bez scene graph alebo verzií). Pre celý záznam použite získať vysvetlenie.

Upraviť vysvetlenie

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

Klin upraviteľnosti. Premeňte pokyn v jednoduchom jazyku na cielené prerenderovanie. Prerenderujú sa iba zasiahnuté scény, čím vznikne nová verzia. Vracia 202 s verziou vo fronte. Dopytujte sa na získať vysvetlenie, kým hlavná verzia nie je ready. Toto sa pripája k existujúcemu videu, takže nespotrebúva ďalší slot na vytvorenie bezplatného videa. Prvé prerenderovanie každého videa je zdarma. Neskoršie používajú minúty plateného plánu a bezplatné účty sú požiadané, aby začali plán. Vysvetlenie už musí byť ready (inak 409).

Telo požiadavky

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

Vrátiť na verziu

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

Presmeruje hlavu na skoršiu pripravenú verziu a zrkadlí jej graf a video na záznam. Cieľ musí byť verzia ready s videom (inak 409).

Telo požiadavky

{ "versionId": "..." }

Živý stream stavu

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

Stream Server-Sent Events (text/event-stream). Otvorte jedno pripojenie a každý prechod stavu na ktoromkoľvek z vašich vysvetlení príde ako rámec event: status, takže môžete aktualizovať stav "video pripravené" v okamihu, keď worker dokončí, namiesto dopytovania. Stream je obmedzený na vlastníka vášho kľúča.

Hlasy

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

Katalóg rozprávačských hlasov. Voliteľný ?language=<code> filtruje na hlasy natívne pre daný jazyk. Vracia voices (každý s priateľským name, id na odovzdanie ako voice, language, isDefault a prehrateľnou preview_url) plus globálny default. Pozri Hlasy.

Jazyky

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

Podporované rozprávačské jazyky ako { code, label, native }. Každý code je platný language pri vytváraní. Pozri Jazyky.

Stav účtu

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

Vracia videosGenerated (za celý život), image účtu a isAdmin. Vyžaduje overenie.

Stav fakturácie

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

Vyžaduje overenie a vracia 200 pre bezplatné aj platené účty. Bezplatný účet vracia plan: "free" s videoAllowance, videosUsed a videosRemaining. Platený účet vracia aj planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining a bonusMinutes.

Konfigurácia za behu a stav

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

Verejné. Vracia { "authEnforced": true }. Kontrola živosti je na GET /health.