API-viite

Jokainen päätepiste pyyntö- ja vastausmuotoineen. Kaikki reitit ovat suhteessa osoitteeseen https://sketchie.ai/api.

Käytännöt

Jokainen /v1/*-päätepiste vaatii Authorization: Bearer sk_...-otsakkeen. Virheet palautuvat JSON-muodossa error-lipulla ja message-viestillä:

Virhevastaus

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

Luontipäätepisteillä on 20 pyynnön minuuttiraja. Kaikki muut päätepisteet jakavat 200 pyynnön minuuttirajan.

Luo selitys

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

Käynnistää luonnin ja palauttaa 202 Accepted jonossa olevalla tietueella. Pollaa hae selitys, kunnes se on ready.

Pyynnön runko

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

Kenttä	Tyyppi	Huomiot
`input`	string	Mitä selittää. Lyhyt kehote tai koko asiakirjateksti. Pakollinen, ellei `source` tai `sceneGraph` ole läsnä. Alias: `prompt`.
`length`	string or number	Tavoitepituus muodossa `"M:SS"` (`"0:30"`, `"1:00"`) tai sekunteina. Positiivinen 30:n monikerta, enintään 360. Jätä pois automaattista pituutta varten. Alias: `lengthSeconds` (luku).
`voice`	string	Valinnainen. Äänen viite. Oletuksena vakiokertoja (Nora). Katso Äänet.
`language`	string	Valinnainen. Tuettu kielikoodi (oletus `en`). Katso Kielet.
`aspect`	string	Valinnainen. `16:9` (oletus), `9:16`, tai `1:1`.
`source`	string	Valinnainen. Asiakirja, artikkeli tai litterointi selitykseksi muutettavaksi. Kun läsnä, `input` muuttuu valinnaiseksi ohjeeksi.
`preset`	string	Valinnainen piirtotyyli: `marker` (oletus), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Valinnainen paljastuksen täyttötekniikka: `A`, `B`, `C` (oletus), tai `D`.
`sceneGraph`	object	Valinnainen. Ennalta kirjoitettu scene graph. Työntekijä ohittaa graafin luonnin ja renderöi sen suoraan, mutta tämä päätepiste luo silti uuden selityksen ja kuluttaa kutsujan normaalin ilmaiskiintiön tai maksullisen suunnitelman kiintiön. Muokataksesi olemassa olevaa selitystä, käytä muokkaa selitystä.

Palauttaa selitystietueen: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null kunnes valmis) ja sceneGraph (null kunnes luotu). 400 palautuu tyhjälle inputille ilman sourcea, virheelliselle lengthille tai virheelliselle aspect, preset, fillMode tai language -arvolle.

Hae selitys

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

Palauttaa koko tietueen: nykyinen status, videoUrl kun ready, muokattava sceneGraph, versiohistoria (versions) ja pääversion kohtaus-chunks. Puuttuva id palauttaa 404.

Listaa selitykset

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

Listaa kutsuvan avaimen selitykset, uusimmat ensin. Rajattu avaimen omistajaan. limit rajataan väliin 1–100 (oletus 50). Palauttaa kevyet yhteenvedot (ei scene graphia tai versioita). Käytä hae selitys koko tietueeseen.

Muokkaa selitystä

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

Muokattavuuden kiila. Muuta selkokielinen ohje kohdennetuksi uudelleenrenderöinniksi. Vain vaikutuksen alaiset kohtaukset renderöidään uudelleen, tuottaen uuden version. Palauttaa 202 jonossa olevalla versiolla. Pollaa hae selitys, kunnes pääversio on ready. Tämä liitetään olemassa olevaan videoon, joten se ei kuluta toista ilmaista videonluontipaikkaa. Kunkin videon ensimmäinen uudelleenrenderöinti on ilmainen. Myöhemmät käyttävät maksullisen suunnitelman minuutteja, ja ilmaistilejä pyydetään aloittamaan suunnitelma. Selityksen on jo oltava ready (muuten 409).

Pyynnön runko

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

Palauta versioon

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

Osoittaa pään uudelleen aiempaan valmiiseen versioon ja peilaa sen graafin ja videon tietueeseen. Kohteen on oltava ready-versio, jossa on video (muuten 409).

Pyynnön runko

{ "versionId": "..." }

Reaaliaikainen tilavirta

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

Server-Sent Events -virta (text/event-stream). Avaa yksi yhteys, ja jokainen tilasiirtymä millä tahansa selityksistäsi saapuu event: status -kehyksenä, joten voit päivittää "video valmis" -tilan sillä hetkellä kun työntekijä valmistuu pollaamisen sijaan. Virta on rajattu avaimesi omistajaan.

Äänet

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

Kerronta-äänten luettelo. Valinnainen ?language=<code> suodattaa ääniin, jotka ovat äidinkielisiä sille kielelle. Palauttaa voices (kukin ystävällisellä name-nimellä, voice-arvona välitettävällä id:llä, language, isDefault ja toistettavalla preview_url) sekä globaalin default. Katso Äänet.

Kielet

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

Tuetut kerrontakielet muodossa { code, label, native }. Jokainen code on kelvollinen language luonnissa. Katso Kielet.

Tilin tila

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

Palauttaa videosGenerated (elinikäinen), tilin image ja isAdmin. Vaatii todennuksen.

Laskutustila

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

Vaatii todennuksen ja palauttaa 200 sekä ilmais- että maksullisille tileille. Ilmaistili palauttaa plan: "free" arvoilla videoAllowance, videosUsed ja videosRemaining. Maksullinen tili palauttaa myös planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining ja bonusMinutes.

Ajonaikainen konfiguraatio ja terveys

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

Julkinen. Palauttaa { "authEnforced": true }. Elossaolotarkistus on osoitteessa GET /health.