Index API

Omnis endpoint, cum forma petitionis et responsionis suae. Omnes viae relativae sunt ad https://sketchie.ai/api.

Conventiones

Omnis endpoint /v1/* caput Authorization: Bearer sk_... requirit. Errores redeunt ut JSON cum vexillo error et message:

Responsio erroris

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

Endpoint generationis ad 20 petitiones per minutam limitantur. Omnes alii endpoint limitem 200 per minutam communicant.

Creare explicativum

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

Incipit generationem et reddit 202 Accepted cum tabula in ordine. Interroga accipere explicativum donec sit ready.

Corpus petitionis

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

Campus	Genus	Notae
`input`	string	Quid explicare. Promptum breve vel textus documenti plenus. Requiritur nisi `source` vel `sceneGraph` adsit. Cognomen: `prompt`.
`length`	string or number	Longitudo proposita ut `"M:SS"` (`"0:30"`, `"1:00"`) vel secundae. Multiplum positivum 30, usque ad 360. Omitte pro longitudine automatica. Cognomen: `lengthSeconds` (numerus).
`voice`	string	Optionale. Ref vocis. Praedefinitum est narrator staturius (Nora). Vide Voces.
`language`	string	Optionale. Codex linguae sustentae (praedefinitum `en`). Vide Linguae.
`aspect`	string	Optionale. `16:9` (praedefinitum), `9:16`, vel `1:1`.
`source`	string	Optionale. Documentum, articulus vel transcriptio in explicativum vertenda. Cum adest, `input` fit directio optionalis.
`preset`	string	Stylus delineandi optionalis: `marker` (praedefinitum), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Technica impletionis revelationis optionalis: `A`, `B`, `C` (praedefinitum), vel `D`.
`sceneGraph`	object	Optionale. scene graph praescriptus. Operarius generationem graphi transilit et eum directe reddit, sed hic endpoint adhuc novum explicativum creat et normalem quotam gratuitam vel quotam consilii soluti vocantis consumit. Ad explicativum exsistens mutandum, utere mutare explicativum.

Reddit tabulam explicativi: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null donec paratum) et sceneGraph (null donec generatum). 400 redit pro input vacuo sine source, length male formata, vel aspect, preset, fillMode vel language invalido.

Accipere explicativum

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

Reddit tabulam plenam: status currentem, videoUrl cum ready, sceneGraph mutabilem, historiam versionum (versions) et chunks scaenae versionis capitis. Id absens reddit 404.

Recensere explicativa

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

Recenset explicativa clavis vocantis, recentissima prima. Limitatum ad possessorem clavis. limit ad 1 usque ad 100 constringitur (praedefinitum 50). Reddit summaria levia (nullus scene graph vel versiones). Pro tabula plena utere accipere explicativum.

Mutare explicativum

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

Cuneus mutabilitatis. Verte praeceptum lingua simplici in redditionem iteratam directam. Solae scaenae affectae iterum redduntur, versionem novam producentes. Reddit 202 cum versione in ordine. Interroga accipere explicativum donec versio capitis sit ready. Hoc pelliculae exsistenti adiungitur, ita alium locum creationis pelliculae gratuitae non consumit. Prima redditio iterata cuiusque pelliculae gratuita est. Posteriores minuta consilii soluti utuntur, et rationibus gratuitis rogatur ut consilium incipiant. Explicativum iam ready esse debet (aliter 409).

Corpus petitionis

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

Revertere ad versionem

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

Caput ad versionem paratam priorem reponit et graphum eius et pelliculam in tabulam speculat. Scopus debet esse versio ready cum pellicula (aliter 409).

Corpus petitionis

{ "versionId": "..." }

Fluxus status vivi

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

Fluxus Server-Sent Events (text/event-stream). Aperi unam connexionem et omnis transitus status in quovis explicativorum tuorum advenit ut compages event: status, ita ut statum "pellicula parata" eo momento renovare possis quo operarius finit pro interrogatione. Fluxus ad possessorem clavis tuae limitatur.

Voces

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

Catalogus vocum narrationis. ?language=<code> optionale ad voces illi linguae nativas filtrat. Reddit voices (quaeque cum name comi, id transmittendo ut voice, language, isDefault et preview_url ludibili) plus default globalem. Vide Voces.

Linguae

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

Linguae narrationis sustentae, ut { code, label, native }. Omnis code est language validum in creatione. Vide Linguae.

Status rationis

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

Reddit videosGenerated (per vitam), image rationis et isAdmin. Authenticationem requirit.

Status rationum

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

Authenticationem requirit et reddit 200 pro rationibus gratuitis et solutis. Ratio gratuita reddit plan: "free" cum videoAllowance, videosUsed et videosRemaining. Ratio soluta etiam reddit planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining et bonusMinutes.

Configuratio temporis exsecutionis et salus

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

Publicum. Reddit { "authEnforced": true }. Inspectio vitalitatis est ad GET /health.