Referans API

Chak endpoint, ak fòm demann ak repons li yo. Tout wout yo relatif ak https://sketchie.ai/api.

Konvansyon

Chak endpoint /v1/* mande antèt Authorization: Bearer sk_.... Erè yo retounen kòm JSON ak yon drapo error ak yon message:

Repons erè

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

Endpoint jenerasyon yo limite a 20 demann pa minit. Tout lòt endpoint yo pataje yon limit 200 pa minit.

Kreye yon explainer

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

Kòmanse yon jenerasyon epi retounen 202 Accepted ak dosye ki nan fil la. Poll jwenn yon explainer jiskaske li ready.

Kò demann

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

Chan	Kalite	Nòt
`input`	string	Kisa pou eksplike. Yon prompt kout oswa tèks dokiman konplè. Obligatwa sof si `source` oswa `sceneGraph` prezan. Alyas: `prompt`.
`length`	string or number	Longè sib kòm `"M:SS"` (`"0:30"`, `"1:00"`) oswa segond. Yon miltip pozitif 30, jiska 360. Kite deyò pou longè otomatik. Alyas: `lengthSeconds` (nonm).
`voice`	string	Opsyonèl. Yon vwa ref. Default se naratè estanda a (Nora). Gade Vwa.
`language`	string	Opsyonèl. Yon kòd lang ki sipòte (default `en`). Gade Lang.
`aspect`	string	Opsyonèl. `16:9` (default), `9:16`, oswa `1:1`.
`source`	string	Opsyonèl. Yon dokiman, atik, oswa transkripsyon pou transfòme an explainer. Lè li prezan, `input` vin yon gid opsyonèl.
`preset`	string	Style desen opsyonèl: `marker` (default), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Teknik ranpli revelasyon opsyonèl: `A`, `B`, `C` (default), oswa `D`.
`sceneGraph`	object	Opsyonèl. Yon scene graph ki ekri davans. Worker la sote jenerasyon graf la epi rann li dirèkteman, men endpoint sa a toujou kreye yon nouvo explainer epi itilize alokasyon gratis nòmal oswa kota plan peye moun kap rele a. Pou modifye yon explainer ki egziste, itilize modifye yon explainer.

Retounen dosye explainer la: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null jiskaske pare) ak sceneGraph (null jiskaske jenere). Yon 400 retounen pou yon input vid san source, yon length ki malfòme, oswa yon aspect, preset, fillMode oswa language ki pa valid.

Jwenn yon explainer

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

Retounen dosye konplè a: status aktyèl, videoUrl yon fwa ready, sceneGraph ki ka modifye, istwa vèsyon (versions) ak chunks sèn vèsyon tèt la. Yon id ki manke retounen 404.

Lis explainer yo

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

Lis explainer kle kap rele a, pi resan an premye. Limite ak pwopriyetè kle a. limit limite soti 1 rive 100 (default 50). Retounen rezime lejè (pa gen scene graph oswa vèsyon). Itilize jwenn yon explainer pou dosye konplè a.

Modifye yon explainer

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

Kal editabilite a. Transfòme yon enstriksyon nan langaj senp an yon re-rann sible. Se sèlman sèn ki afekte yo ki rann ankò, ki pwodwi yon nouvo vèsyon. Retounen 202 ak vèsyon ki nan fil la. Poll jwenn yon explainer jiskaske vèsyon tèt la ready. Sa ajoute ak videyo ki egziste a, kidonk li pa itilize yon lòt plas kreyasyon videyo gratis. Premye re-rann chak videyo gratis. Sa ki vin apre yo itilize minit plan peye, epi kont gratis yo mande pou kòmanse yon plan. Explainer la dwe deja ready (sinon 409).

Kò demann

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

Retounen nan yon vèsyon

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

Re-pwente tèt la sou yon vèsyon ki pare pi bonè epi reflete graf ak videyo li sou dosye a. Sib la dwe yon vèsyon ready ak yon videyo (sinon 409).

Kò demann

{ "versionId": "..." }

Flux estati an dirèk

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

Yon flux Server-Sent Events (text/event-stream). Louvri yon koneksyon epi chak tranzisyon estati sou nenpòt nan explainer ou yo rive kòm yon fram event: status, konsa ou ka mete ajou yon eta "videyo pare" nan moman worker la fini olye poll. Flux la limite ak pwopriyetè kle ou.

Vwa

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

Katalòg vwa naratif la. ?language=<code> opsyonèl la filtre nan vwa natif pou lang sa a. Retounen voices (chak ak yon name zanmitay, id pou pase kòm voice, language, isDefault ak yon preview_url ou ka jwe) plis default global la. Gade Vwa.

Lang

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

Lang naratif ki sipòte yo, kòm { code, label, native }. Chak code se yon language valid nan kreyasyon. Gade Lang.

Eta kont

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

Retounen videosGenerated (pou tout lavi), image kont la ak isAdmin. Mande otantifikasyon.

Estati faktirasyon

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

Mande otantifikasyon epi retounen 200 pou kont gratis ak peye. Yon kont gratis retounen plan: "free" ak videoAllowance, videosUsed ak videosRemaining. Yon kont peye retounen tou planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining ak bonusMinutes.

Config ègzekisyon ak sante

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

Piblik. Retounen { "authEnforced": true }. Yon tchèk vivan nan GET /health.