API erreferentzia

Endpoint bakoitza, bere eskaera eta erantzun formarekin. Ibilbide guztiak https://sketchie.ai/api-rekiko erlatiboak dira.

Konbentzioak

/v1/* endpoint bakoitzak Authorization: Bearer sk_... goiburua behar du. Erroreak JSON gisa itzultzen dira error banderarekin eta message-rekin:

Errore erantzuna

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

Sorkuntza endpoint-ak minutuko 20 eskaeratara mugatuta daude. Gainerako endpoint guztiek minutuko 200eko muga partekatzen dute.

Sortu azalpen bat

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

Sorkuntza bat abiarazten du eta 202 Accepted itzultzen du ilaran dagoen erregistroarekin. Galdetu azalpen bat eskuratu ready izan arte.

Eskaeraren gorputza

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

Eremua	Mota	Oharrak
`input`	string	Zer azaldu. Prompt labur bat edo dokumentu testu osoa. Beharrezkoa `source` edo `sceneGraph` ez badago. Aliasa: `prompt`.
`length`	string or number	Helburu-luzera `"M:SS"` (`"0:30"`, `"1:00"`) gisa edo segundoak. 30en multiplo positiboa, 360 arte. Utzi luzera automatikorako. Aliasa: `lengthSeconds` (zenbakia).
`voice`	string	Aukerakoa. Ahots ref bat. Lehenetsia kontalari estandarra (Nora). Ikus Ahotsak.
`language`	string	Aukerakoa. Onartutako hizkuntza-kodea (lehenetsia `en`). Ikus Hizkuntzak.
`aspect`	string	Aukerakoa. `16:9` (lehenetsia), `9:16`, edo `1:1`.
`source`	string	Aukerakoa. Azalpen bihurtzeko dokumentu, artikulu edo transkripzio bat. Dagoenean, `input` aukerako gida bihurtzen da.
`preset`	string	Aukerako marrazketa-estiloa: `marker` (lehenetsia), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Aukerako agerpen-betetze teknika: `A`, `B`, `C` (lehenetsia), edo `D`.
`sceneGraph`	object	Aukerakoa. Aldez aurretik idatzitako scene graph bat. Langileak grafoaren sorkuntza saltatzen du eta zuzenean errenderizatzen du, baina endpoint honek oraindik azalpen berri bat sortzen du eta deitzailearen doako esleipen arrunta edo ordainpeko planaren kuota kontsumitzen du. Dagoen azalpen bat editatzeko, erabili azalpen bat editatu.

Azalpenaren erregistroa itzultzen du: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null prest egon arte) eta sceneGraph (null sortu arte). 400 bat itzultzen da source gabeko input huts baterako, gaizki osatutako length baterako, edo baliogabeko aspect, preset, fillMode edo language baterako.

Azalpen bat eskuratu

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

Erregistro osoa itzultzen du: uneko status, videoUrl ready denean, sceneGraph editagarria, bertsio-historia (versions) eta buru-bertsioaren eszena-chunks. Falta den id batek 404 itzultzen du.

Azalpenak zerrendatu

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

Deitzen ari den gakoaren azalpenak zerrendatzen ditu, berrienak lehenengo. Gakoaren jabera mugatuta. limit 1etik 100era mugatzen da (lehenetsia 50). Laburpen arinak itzultzen ditu (scene graph edo bertsiorik gabe). Erregistro osorako erabili azalpen bat eskuratu.

Azalpen bat editatu

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

Editagarritasunaren ziria. Bihurtu hizkuntza arruntean egindako jarraibide bat helburuko birrenderizazio batean. Eragindako eszenak soilik birrenderizatzen dira, bertsio berri bat sortuz. 202 itzultzen du ilaran dagoen bertsioarekin. Galdetu azalpen bat eskuratu buru-bertsioa ready izan arte. Hau lehendik dagoen bideoari gehitzen zaio, beraz ez du beste doako bideo sorkuntza toki bat kontsumitzen. Bideo bakoitzaren lehen birrenderizazioa doakoa da. Geroagokoek ordainpeko planaren minutuak erabiltzen dituzte, eta doako kontuei plan bat hastea eskatzen zaie. Azalpena jada ready egon behar da (bestela 409).

Eskaeraren gorputza

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

Bertsio batera itzuli

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

Burua lehenagoko prest bertsio batera birbideratzen du eta bere grafoa eta bideoa erregistroan islatzen ditu. Helburua bideoa duen ready bertsio bat izan behar da (bestela 409).

Eskaeraren gorputza

{ "versionId": "..." }

Zuzeneko egoera-jarioa

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

Server-Sent Events jario bat (text/event-stream). Ireki konexio bat eta zure azalpenetako edozeinetan egoera-trantsizio bakoitza event: status marko gisa iristen da, beraz "bideoa prest" egoera bat egunera dezakezu langilea amaitzen den unean, galdetu beharrean. Jarioa zure gakoaren jabera mugatuta dago.

Ahotsak

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

Narrazio-ahotsen katalogoa. Aukerako ?language=<code>-k hizkuntza horren jatorrizko ahotsetara iragazten du. voices itzultzen du (bakoitzak name atsegin batekin, voice gisa pasatzeko id-arekin, language, isDefault eta erreproduzi daitekeen preview_url-arekin) gehi default globala. Ikus Ahotsak.

Hizkuntzak

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

Onartutako narrazio-hizkuntzak, { code, label, native } gisa. code bakoitza language baliozkoa da sortzean. Ikus Hizkuntzak.

Kontuaren egoera

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

videosGenerated (bizitza osokoa), kontuaren image eta isAdmin itzultzen ditu. Autentifikazioa behar du.

Fakturazioaren egoera

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

Autentifikazioa behar du eta 200 itzultzen du bai doako bai ordainpeko kontuetarako. Doako kontu batek plan: "free" itzultzen du videoAllowance, videosUsed eta videosRemaining-ekin. Ordainpeko kontu batek planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining eta bonusMinutes ere itzultzen ditu.

Exekuzio-denborako konfigurazioa eta osasuna

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

Publikoa. { "authEnforced": true } itzultzen du. Bizitasun-egiaztapena GET /health-en dago.