API viide

Iga lõpp-punkt oma päringu ja vastuse vormiga. Kõik marsruudid on suhtelised aadressiga https://sketchie.ai/api.

Kokkulepped

Iga /v1/* lõpp-punkt nõuab päist Authorization: Bearer sk_.... Vead tulevad tagasi JSON-ina lipuga error ja message:

Veavastus

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

Genereerimise lõpp-punktid on piiratud 20 päringuga minutis. Kõik teised lõpp-punktid jagavad 200 minutis piiri.

Loo selgitus

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

Käivitab genereerimise ja tagastab 202 Accepted järjekorras oleva kirjega. Küsitle hangi selgitus, kuni see on ready.

Päringu keha

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

Väli	Tüüp	Märkused
`input`	string	Mida selgitada. Lühike viip või täielik dokumenditekst. Nõutav, kui pole `source` või `sceneGraph`. Alias: `prompt`.
`length`	string or number	Sihtpikkus kujul `"M:SS"` (`"0:30"`, `"1:00"`) või sekundid. 30 positiivne kordne, kuni 360. Jäta välja automaatse pikkuse jaoks. Alias: `lengthSeconds` (arv).
`voice`	string	Valikuline. Hääle viide. Vaikimisi standardne jutustaja (Nora). Vaata Hääled.
`language`	string	Valikuline. Toetatud keelekood (vaikimisi `en`). Vaata Keeled.
`aspect`	string	Valikuline. `16:9` (vaikimisi), `9:16`, või `1:1`.
`source`	string	Valikuline. Dokument, artikkel või transkript, mida selgituseks muuta. Kui see on olemas, muutub `input` valikuliseks juhiseks.
`preset`	string	Valikuline joonistusstiil: `marker` (vaikimisi), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Valikuline paljastuse täitmise tehnika: `A`, `B`, `C` (vaikimisi), või `D`.
`sceneGraph`	object	Valikuline. Eelnevalt kirjutatud scene graph. Töötaja jätab graafi genereerimise vahele ja renderdab selle otse, kuid see lõpp-punkt loob ikkagi uue selgituse ja tarbib helistaja tavalist tasuta kvooti või tasulise plaani kvooti. Olemasoleva selgituse redigeerimiseks kasuta redigeeri selgitust.

Tagastab selgituse kirje: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null kuni valmis) ja sceneGraph (null kuni genereeritud). 400 tuleb tagasi tühja inputi puhul ilma sourceta, vigase lengthi puhul või vigase aspect, preset, fillMode või language puhul.

Hangi selgitus

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

Tagastab kogu kirje: praegune status, videoUrl kui ready, redigeeritav sceneGraph, versiooniajalugu (versions) ja peaversiooni stseeni chunks. Puuduv id tagastab 404.

Loenda selgitusi

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

Loendab helistava võtme selgitused, uusimad esimesena. Piiratud võtme omanikuga. limit piiratakse vahemikku 1 kuni 100 (vaikimisi 50). Tagastab kerged kokkuvõtted (ei scene graphi ega versioone). Kogu kirje jaoks kasuta hangi selgitus.

Redigeeri selgitust

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

Redigeeritavuse kiil. Muuda lihtsas keeles juhis sihitud ümberrenderimiseks. Ainult mõjutatud stseenid renderitakse uuesti, luues uue versiooni. Tagastab 202 järjekorras oleva versiooniga. Küsitle hangi selgitus, kuni peaversioon on ready. See lisatakse olemasolevale videole, seega ei tarbi see teist tasuta video loomise pesa. Iga video esimene ümberrenderimine on tasuta. Hilisemad kasutavad tasulise plaani minuteid ja tasuta kontodel palutakse alustada plaani. Selgitus peab olema juba ready (muidu 409).

Päringu keha

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

Taasta versioonile

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

Suunab pea tagasi varasemale valmis versioonile ja peegeldab selle graafi ja video kirjesse. Sihtmärk peab olema ready versioon videoga (muidu 409).

Päringu keha

{ "versionId": "..." }

Reaalajas olekuvoog

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

Server-Sent Eventsi voog (text/event-stream). Ava üks ühendus ja iga olekusiire mis tahes su selgitusel saabub event: status kaadrina, nii et saad uuendada "video valmis" oleku hetkel, mil töötaja lõpetab, selle asemel et küsitleda. Voog on piiratud su võtme omanikuga.

Hääled

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

Jutustushäälte kataloog. Valikuline ?language=<code> filtreerib häältele, mis on sellele keelele emakeelsed. Tagastab voices (igaüks sõbraliku name, id-ga, mida edastada voice-na, language, isDefault ja esitatava preview_url) pluss globaalse default. Vaata Hääled.

Keeled

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

Toetatud jutustuskeeled kujul { code, label, native }. Iga code on kehtiv language loomisel. Vaata Keeled.

Konto olek

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

Tagastab videosGenerated (eluaegne), konto image ja isAdmin. Nõuab autentimist.

Arvelduse olek

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

Nõuab autentimist ja tagastab 200 nii tasuta kui ka tasulistele kontodele. Tasuta konto tagastab plan: "free" koos videoAllowance, videosUsed ja videosRemaining. Tasuline konto tagastab ka planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining ja bonusMinutes.

Käitusaja konfiguratsioon ja tervis

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

Avalik. Tagastab { "authEnforced": true }. Elususkontroll asub GET /health.