Referenca API

Vsaka končna točka z obliko njene zahteve in odgovora. Vse poti so relativne glede na https://sketchie.ai/api.

Konvencije

Vsaka končna točka /v1/* zahteva glavo Authorization: Bearer sk_.... Napake se vrnejo kot JSON z zastavico error in message:

Odgovor z napako

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

Končne točke generiranja so omejene na 20 zahtev na minuto. Vse druge končne točke si delijo omejitev 200 na minuto.

Ustvarite razlago

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

Zažene generiranje in vrne 202 Accepted z zapisom v čakalni vrsti. Poizvedujte po pridobi razlago, dokler ni ready.

Telo zahteve

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

Polje	Tip	Opombe
`input`	string	Kaj razložiti. Kratek poziv ali celotno besedilo dokumenta. Obvezno, razen če je prisoten `source` ali `sceneGraph`. Vzdevek: `prompt`.
`length`	string or number	Ciljna dolžina kot `"M:SS"` (`"0:30"`, `"1:00"`) ali sekunde. Pozitivni večkratnik 30, do 360. Izpustite za samodejno dolžino. Vzdevek: `lengthSeconds` (število).
`voice`	string	Neobvezno. Sklic glasu. Privzeto standardni pripovedovalec (Nora). Glejte Glasovi.
`language`	string	Neobvezno. Podprta koda jezika (privzeto `en`). Glejte Jeziki.
`aspect`	string	Neobvezno. `16:9` (privzeto), `9:16`, ali `1:1`.
`source`	string	Neobvezno. Dokument, članek ali prepis za pretvorbo v razlago. Ko je prisoten, `input` postane neobvezno navodilo.
`preset`	string	Neobvezni slog risanja: `marker` (privzeto), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Neobvezna tehnika polnjenja razkritja: `A`, `B`, `C` (privzeto), ali `D`.
`sceneGraph`	object	Neobvezno. Vnaprej napisan scene graph. Worker preskoči generiranje grafa in ga upodobi neposredno, vendar ta končna točka še vedno ustvari novo razlago in porabi običajno brezplačno kvoto ali kvoto plačljivega paketa klicatelja. Za urejanje obstoječe razlage uporabite uredi razlago.

Vrne zapis razlage: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null do pripravljenosti) in sceneGraph (null do generiranja). 400 se vrne za prazen input brez source, napačno oblikovan length ali neveljaven aspect, preset, fillMode ali language.

Pridobi razlago

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

Vrne celoten zapis: trenutni status, videoUrl ko je ready, urejljivi sceneGraph, zgodovino različic (versions) in scenske chunks glavne različice. Manjkajoč id vrne 404.

Seznam razlag

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

Našteje razlage klicnega ključa, najnovejše prve. Omejeno na lastnika ključa. limit je omejen na 1 do 100 (privzeto 50). Vrne lahke povzetke (brez scene graph ali različic). Za celoten zapis uporabite pridobi razlago.

Uredi razlago

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

Klin urejljivosti. Spremenite navodilo v preprostem jeziku v ciljno ponovno upodabljanje. Ponovno se upodobijo samo prizadete scene, kar ustvari novo različico. Vrne 202 z različico v čakalni vrsti. Poizvedujte po pridobi razlago, dokler glavna različica ni ready. To se doda obstoječemu videu, zato ne porabi še ene reže za ustvarjanje brezplačnega videa. Prvo ponovno upodabljanje vsakega videa je brezplačno. Kasnejša uporabljajo minute plačljivega paketa, brezplačni računi pa so pozvani, naj začnejo paket. Razlaga mora biti že ready (sicer 409).

Telo zahteve

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

Povrni na različico

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

Preusmeri glavo na prejšnjo pripravljeno različico ter zrcali njen graf in video na zapis. Cilj mora biti različica ready z videom (sicer 409).

Telo zahteve

{ "versionId": "..." }

Tok stanja v živo

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

Tok Server-Sent Events (text/event-stream). Odprite eno povezavo in vsak prehod stanja na kateri koli od vaših razlag prispe kot okvir event: status, tako da lahko posodobite stanje "video pripravljen" v trenutku, ko worker konča, namesto poizvedovanja. Tok je omejen na lastnika vašega ključa.

Glasovi

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

Katalog pripovedovalskih glasov. Neobvezni ?language=<code> filtrira na glasove, ki so domači temu jeziku. Vrne voices (vsak s prijaznim name, id za posredovanje kot voice, language, isDefault in predvajljiv preview_url) ter globalni default. Glejte Glasovi.

Jeziki

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

Podprti pripovedovalski jeziki kot { code, label, native }. Vsak code je veljaven language pri ustvarjanju. Glejte Jeziki.

Stanje računa

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

Vrne videosGenerated (vseživljenjsko), image računa in isAdmin. Zahteva overjanje.

Stanje obračunavanja

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

Zahteva overjanje in vrne 200 za brezplačne in plačljive račune. Brezplačni račun vrne plan: "free" z videoAllowance, videosUsed in videosRemaining. Plačljivi račun vrne tudi planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining in bonusMinutes.

Konfiguracija izvajanja in zdravje

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

Javno. Vrne { "authEnforced": true }. Preverjanje živosti je na GET /health.