API-Referenz

All endpoint, mat der Form vu senger Ufro an Äntwert. All Weeër si relativ zu https://sketchie.ai/api.

Konventiounen

All /v1/*-endpoint erfuerdert den Authorization: Bearer sk_...-Header. Feeler kommen als JSON mat engem error-Fändel an engem message zréck:

Feeler-Äntwert

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

Generatiouns-endpoint si limitéiert op 20 Ufroe pro Minutt. All aner endpoint deelen eng Limit vun 200 pro Minutt.

Erstellt eng Erklärung

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

Start eng Generatioun a gëtt 202 Accepted mam Rekord an der Schlaang zréck. Pollt eng Erklärung kréien bis se ready ass.

Ufro-Kierper

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

Feld	Typ	Notizen
`input`	string	Wat ze erklären. E kuerze Prompt oder de voll Dokumenttext. Erfuerderlech ausser `source` oder `sceneGraph` ass do. Alias: `prompt`.
`length`	string or number	Ziel-Längt als `"M:SS"` (`"0:30"`, `"1:00"`) oder Sekonnen. E positive Villfacht vun 30, bis 360. Loosst ewech fir automatesch Längt. Alias: `lengthSeconds` (Zuel).
`voice`	string	Optional. Eng Stëmm-Ref. Standard ass den Standard-Erzieler (Nora). Kuckt Stëmmen.
`language`	string	Optional. En ënnerstëtzte Sproochcode (Standard `en`). Kuckt Sproochen.
`aspect`	string	Optional. `16:9` (Standard), `9:16`, oder `1:1`.
`source`	string	Optional. En Dokument, Artikel oder Transkript fir an eng Erklärung ze verwandelen. Wann do, gëtt `input` eng optional Uleedung.
`preset`	string	Optionellen Zeechenstil: `marker` (Standard), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Optionell Opdeckungs-Fülltechnik: `A`, `B`, `C` (Standard), oder `D`.
`sceneGraph`	object	Optional. E virgeschriwwene scene graph. De Worker iwwersprëngt d'Graphgeneratioun a rendert en direkt, awer dësen endpoint erstellt ëmmer nach eng nei Erklärung a verbraucht déi normal gratis Zoudeelung oder d'Quota vum bezuelte Plang vum Uruffer. Fir eng bestehend Erklärung z'änneren, benotzt eng Erklärung änneren.

Gëtt de Erklärungsrekord zréck: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null bis fäerdeg) an sceneGraph (null bis generéiert). E 400 kënnt zréck fir e eidelen input ouni source, eng falsch geformt length, oder en ongëltege aspect, preset, fillMode oder language.

Eng Erklärung kréien

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

Gëtt de ganze Rekord zréck: aktuellen status, d'videoUrl soubal ready, den editéierbare sceneGraph, d'Versiounsgeschicht (versions) an d'Szenen-chunks vun der Kappversioun. Eng fehlend id gëtt 404 zréck.

Erklärunge lëschten

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

Lëscht d'Erklärunge vum uruffende Schlëssel, déi neist fir d'éischt. Limitéiert op de Besëtzer vum Schlëssel. limit gëtt op 1 bis 100 begrenzt (Standard 50). Gëtt liicht Resuméen zréck (kee scene graph oder Versiounen). Fir de ganze Rekord benotzt eng Erklärung kréien.

Eng Erklärung änneren

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

De Keil vun der Ännerbarkeet. Verwandelt eng Uweisung a klorer Sprooch an e geziilt Neirenderen. Nëmmen déi betraffe Szene ginn nei gerendert, wat eng nei Versioun produzéiert. Gëtt 202 mat der Versioun an der Schlaang zréck. Pollt eng Erklärung kréien bis d'Kappversioun ready ass. Dëst gëtt un dat bestehend Video ugehaang, sou datt et keng aner gratis-Video-Erstellungsplaz verbraucht. Dat éischt Neirenderen vun all Video ass gratis. Spéider benotze Minutte vum bezuelte Plang, a gratis Konten ginn gefrot fir e Plang unzefänken. D'Erklärung muss scho ready sinn (soss 409).

Ufro-Kierper

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

Op eng Versioun zrécksetzen

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

Weist de Kapp op eng fréier fäerdeg Versioun zréck a spigelt hire Graph a Video op de Rekord. D'Zil muss eng ready-Versioun mat engem Video sinn (soss 409).

Ufro-Kierper

{ "versionId": "..." }

Live Statusstroum

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

E Server-Sent Events-Stroum (text/event-stream). Maacht eng Verbindung op an all Statusiwwergang op iergendenger vun ären Erklärunge kënnt als e event: status-Frame un, sou datt der en "Video fäerdeg"-Zoustand am Moment aktualiséiere kënnt, wou de Worker fäerdeg ass, amplaz ze pollen. De Stroum ass op de Besëtzer vun ärem Schlëssel limitéiert.

Stëmmen

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

De Katalog vun den Erzielstëmmen. Den optionellen ?language=<code> filtert op Stëmmen déi an där Sprooch native sinn. Gëtt voices zréck (jiddereng mat engem frëndlechen name, der id fir als voice ze iwwerginn, language, isDefault an engem ofspillbare preview_url) plus dee globale default. Kuckt Stëmmen.

Sproochen

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

Déi ënnerstëtzt Erzielsproochen, als { code, label, native }. All code ass e gëltege language beim Erstellen. Kuckt Sproochen.

Kontostatus

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

Gëtt videosGenerated (liewenslaang), d'image vum Konto an isAdmin zréck. Erfuerdert Authentifikatioun.

Rechnungsstatus

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

Erfuerdert Authentifikatioun a gëtt 200 fir souwuel gratis wéi bezuelte Konten zréck. E gratis Konto gëtt plan: "free" mat videoAllowance, videosUsed an videosRemaining zréck. E bezuelte Konto gëtt och planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining an bonusMinutes zréck.

Runtime-Konfiguratioun a Gesondheet

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

Ëffentlech. Gëtt { "authEnforced": true } zréck. E Liewegkeetscheck ass op GET /health.