Referencë API

Çdo endpoint, me formën e kërkesës dhe përgjigjes së tij. Të gjitha rrugët janë relative ndaj https://sketchie.ai/api.

Konventat

Çdo endpoint /v1/* kërkon kokën Authorization: Bearer sk_.... Gabimet kthehen si JSON me një flamur error dhe një message:

Përgjigje gabimi

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

Endpoint-et e gjenerimit kufizohen në 20 kërkesa në minutë. Të gjitha endpoint-et e tjera ndajnë një kufi prej 200 në minutë.

Krijoni një shpjegues

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

Nis një gjenerim dhe kthen 202 Accepted me regjistrimin në radhë. Kërkoni merrni një shpjegues derisa të jetë ready.

Trupi i kërkesës

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

Fusha	Lloji	Shënime
`input`	string	Çfarë të shpjegoni. Një prompt i shkurtër ose teksti i plotë i dokumentit. E detyrueshme përveç nëse `source` ose `sceneGraph` është i pranishëm. Alias: `prompt`.
`length`	string or number	Gjatësia e synuar si `"M:SS"` (`"0:30"`, `"1:00"`) ose sekonda. Shumëfish pozitiv i 30, deri në 360. Hiqni për gjatësi automatike. Alias: `lengthSeconds` (numër).
`voice`	string	Opsionale. Një ref zëri. Parazgjedhja është tregimtari standard (Nora). Shihni Zërat.
`language`	string	Opsionale. Një kod gjuhe i mbështetur (parazgjedhja `en`). Shihni Gjuhët.
`aspect`	string	Opsionale. `16:9` (parazgjedhja), `9:16`, ose `1:1`.
`source`	string	Opsionale. Një dokument, artikull ose transkript për ta shndërruar në shpjegues. Kur është i pranishëm, `input` bëhet udhëzim opsional.
`preset`	string	Stil vizatimi opsional: `marker` (parazgjedhja), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Teknikë mbushjeje zbulimi opsionale: `A`, `B`, `C` (parazgjedhja), ose `D`.
`sceneGraph`	object	Opsionale. Një scene graph i shkruar paraprakisht. Punëtori kapërcen gjenerimin e grafit dhe e renderon drejtpërdrejt, por ky endpoint ende krijon një shpjegues të ri dhe konsumon kuotën normale falas ose kuotën e planit me pagesë të thirrësit. Për të redaktuar një shpjegues ekzistues, përdorni redaktoni një shpjegues.

Kthen regjistrimin e shpjeguesit: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null deri sa gati) dhe sceneGraph (null deri sa gjenerohet). Një 400 kthehet për një input bosh pa source, një length të keqformuar, ose një aspect, preset, fillMode ose language të pavlefshëm.

Merrni një shpjegues

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

Kthen regjistrimin e plotë: status-in aktual, videoUrl-në kur ready, sceneGraph-un e redaktueshëm, historikun e versioneve (versions) dhe chunks-et e skenës të versionit kryesor. Një id që mungon kthen 404.

Listoni shpjeguesit

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

Liston shpjeguesit e çelësit thirrës, më të rinjtë të parët. I kufizuar te pronari i çelësit. limit kufizohet nga 1 në 100 (parazgjedhja 50). Kthen përmbledhje të lehta (pa scene graph ose versione). Për regjistrimin e plotë përdorni merrni një shpjegues.

Redaktoni një shpjegues

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

Pyka e redaktueshmërisë. Shndërroni një udhëzim në gjuhë të thjeshtë në një ri-render të synuar. Vetëm skenat e prekura ri-renderohen, duke prodhuar një version të ri. Kthen 202 me versionin në radhë. Kërkoni merrni një shpjegues derisa versioni kryesor të jetë ready. Kjo i shtohet videos ekzistuese, kështu që nuk konsumon një tjetër vend krijimi videoje falas. Ri-renderi i parë i çdo videoje është falas. Të mëvonshmit përdorin minuta të planit me pagesë, dhe llogarive falas u kërkohet të fillojnë një plan. Shpjeguesi duhet të jetë tashmë ready (përndryshe 409).

Trupi i kërkesës

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

Kthehuni te një version

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

Ridrejton kokën te një version i mëparshëm i gatshëm dhe pasqyron grafin dhe videon e tij në regjistrim. Objektivi duhet të jetë një version ready me një video (përndryshe 409).

Trupi i kërkesës

{ "versionId": "..." }

Transmetim statusi i drejtpërdrejtë

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

Një transmetim Server-Sent Events (text/event-stream). Hapni një lidhje dhe çdo tranzicion statusi në cilindo nga shpjeguesit tuaj mbërrin si një kornizë event: status, kështu që mund të përditësoni një gjendje "video gati" në momentin që punëtori mbaron në vend të kërkimit. Transmetimi është i kufizuar te pronari i çelësit tuaj.

Zërat

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

Katalogu i zërave të tregimit. Opsionali ?language=<code> filtron te zërat vendas të asaj gjuhe. Kthen voices (secili me një name miqësor, id-në për ta kaluar si voice, language, isDefault dhe një preview_url të luajtshëm) plus default-in global. Shihni Zërat.

Gjuhët

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

Gjuhët e mbështetura të tregimit, si { code, label, native }. Çdo code është një language i vlefshëm në krijim. Shihni Gjuhët.

Gjendja e llogarisë

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

Kthen videosGenerated (gjatë gjithë jetës), image-n e llogarisë dhe isAdmin. Kërkon vërtetim.

Statusi i faturimit

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

Kërkon vërtetim dhe kthen 200 për llogaritë falas dhe me pagesë. Një llogari falas kthen plan: "free" me videoAllowance, videosUsed dhe videosRemaining. Një llogari me pagesë kthen gjithashtu planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining dhe bonusMinutes.

Konfigurimi i kohës së ekzekutimit dhe shëndeti

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

Publik. Kthen { "authEnforced": true }. Një kontroll gjallërie ndodhet te GET /health.