Fanondroana API

endpoint tsirairay, miaraka amin'ny endriky ny fangatahana sy ny valiny. Ny lalana rehetra dia mifanaraka amin'ny https://sketchie.ai/api.

Fifanarahana

endpoint /v1/* tsirairay dia mitaky ny lohateny Authorization: Bearer sk_.... Ny hadisoana dia miverina ho JSON miaraka amin'ny saina error sy message:

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

Ny endpoint famoronana dia voafetra ho 20 fangatahana isaky ny minitra. Ny endpoint hafa rehetra dia mizara fetra 200 isaky ny minitra.

Mamorona fanazavana

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

Manomboka famoronana ary mamerina 202 Accepted miaraka amin'ny firaketana milahatra. poll maka fanazavana mandra-pahatongan'ny ready.

Vatan'ny fangatahana
{
  "input": "Explain how DNS resolves a domain name",
  "length": "0:30",
  "aspect": "16:9",
  "voice": "sketchie:sulafat",
  "language": "en"
}
SahaKarazanaFanamarihana
input string Inona no hazavaina. prompt fohy na lahatsoratra antontan-taratasy feno. Ilaina raha tsy misy source na sceneGraph. Anaram-bositra: prompt.
length string or number Halavana kendrena ho "M:SS" ("0:30", "1:00") na segondra. Mari-batana miompana amin'ny 30 hatramin'ny 360. Esory ho an'ny halavana mandeha ho azy. Anaram-bositra: lengthSeconds (isa).
voice string Safidy. ref feo. Raikitra ny mpitantara mahazatra (Nora). Jereo Feo.
language string Safidy. kaody fiteny tohanana (raikitra en). Jereo Fiteny.
aspect string Safidy. 16:9 (raikitra), 9:16, na 1:1.
source string Safidy. Antontan-taratasy, lahatsoratra na fanoratana hovaina ho fanazavana. Rehefa misy, input dia lasa toromarika safidy.
preset string Fomba fanoratana safidy: marker (raikitra), chalkboard, pencil, blueprint, crayon, clean.
fillMode string Teknika fameno fampisehoana safidy: A, B, C (raikitra), na D.
sceneGraph object Safidy. scene graph voasoratra mialoha. Ny worker dia mandingana ny famoronana grafika ary mandoko azy mivantana, saingy ity endpoint ity dia mbola mamorona fanazavana vaovao ary mandany ny anjara maimaim-poana mahazatra na ny anjara drafitra andoavam-bola an'ny mpiantso. Mba hanovana fanazavana efa misy, ampiasao hanova fanazavana.

Mamerina ny firaketana fanazavana: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null mandra-pahavita) sy sceneGraph (null mandra-pamorona). Miverina ny 400 ho an'ny input foana tsy misy source, length ratsy endrika, na aspect, preset, fillMode na language tsy manan-kery.

Maka fanazavana

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

Mamerina ny firaketana feno: status ankehitriny, ny videoUrl rehefa ready, ny sceneGraph azo ovaina, ny tantaran'ny kinova (versions) ary ny chunks sehatra amin'ny kinova lohany. Ny id tsy hita dia mamerina 404.

Lisitra fanazavana

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

Mitanisa ny fanazavan'ny lakile miantso, ny vaovao indrindra aloha. Voafetra amin'ny tompon'ny lakile. limit dia voafetra 1 ka hatramin'ny 100 (raikitra 50). Mamerina famintinana maivana (tsy misy scene graph na kinova). Ampiasao maka fanazavana ho an'ny firaketana feno.

Hanova fanazavana

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

Ny kofehin'ny fahafahana ovaina. Ovay ho render indray mikendry ny toromarika amin'ny teny tsotra. Ny sehatra voakasika ihany no render indray, mamokatra kinova vaovao. Mamerina 202 miaraka amin'ny kinova milahatra. poll maka fanazavana mandra-pahatongan'ny kinova lohany ho ready. Ity dia manampy amin'ny video efa misy, ka tsy mandany toerana famoronana video maimaim-poana hafa. Ny render indray voalohany amin'ny video tsirairay dia maimaim-poana. Ny manaraka dia mampiasa minitra drafitra andoavam-bola, ary asaina manomboka drafitra ny kaonty maimaim-poana. Tsy maintsy efa ready ny fanazavana (raha tsy izany 409).

Vatan'ny fangatahana
{ "instruction": "Make the title scene shorter and warmer" }

Mamerina amin'ny kinova

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

Manondro indray ny loha amin'ny kinova vonona teo aloha ary mamerina ny grafika sy ny video amin'ny firaketana. Ny tanjona dia tsy maintsy kinova ready misy video (raha tsy izany 409).

Vatan'ny fangatahana
{ "versionId": "..." }

Tsindraka sata mivantana

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

Tsindraka Server-Sent Events (text/event-stream). Sokafy fifandraisana iray ary ny fiovan'ny sata tsirairay amin'ny iray amin'ny fanazavanao dia tonga ho endrika event: status, ka afaka manavao sata "video vonona" amin'ny fotoana mahavita ny worker ianao fa tsy poll. Ny tsindraka dia voafetra amin'ny tompon'ny lakilenao.

Feo

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

Katalaogin'ny feo fitantarana. Ny ?language=<code> safidy dia manivana ny feo teratany amin'io fiteny io. Mamerina voices (samy manana name mora, id alefa ho voice, language, isDefault ary preview_url azo alefa) miampy ny default manerantany. Jereo Feo.

Fiteny

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

Ny fiteny fitantarana tohanana, ho { code, label, native }. Ny code tsirairay dia language manan-kery amin'ny famoronana. Jereo Fiteny.

Satan'ny kaonty

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

Mamerina videosGenerated (mandritra ny androm-piainana), ny image kaonty sy isAdmin. Mitaky fanamarinana.

Satan'ny fandoavam-bola

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

Mitaky fanamarinana ary mamerina 200 ho an'ny kaonty maimaim-poana sy andoavam-bola. Ny kaonty maimaim-poana dia mamerina plan: "free" miaraka amin'ny videoAllowance, videosUsed sy videosRemaining. Ny kaonty andoavam-bola dia mamerina koa ny planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining sy bonusMinutes.

Config fotoana fandehanana sy fahasalamana

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

Bevava. Mamerina { "authEnforced": true }. Misy fanamarinana fahavelomana ao amin'ny GET /health.