API uzziņa

Katrs galapunkts ar tā pieprasījuma un atbildes formu. Visi maršruti ir relatīvi pret https://sketchie.ai/api.

Konvencijas

Katram /v1/* galapunktam nepieciešama galvene Authorization: Bearer sk_.... Kļūdas atgriežas kā JSON ar karodziņu error un message:

Kļūdas atbilde

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

Ģenerēšanas galapunkti ir ierobežoti līdz 20 pieprasījumiem minūtē. Visi pārējie galapunkti dala 200 minūtē ierobežojumu.

Izveidojiet skaidrojumu

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

Sāk ģenerēšanu un atgriež 202 Accepted ar ierakstu rindā. Aptaujājiet iegūt skaidrojumu, līdz tas ir ready.

Pieprasījuma pamatteksts

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

Lauks	Tips	Piezīmes
`input`	string	Ko izskaidrot. Īsa uzvedne vai pilns dokumenta teksts. Obligāti, ja vien nav `source` vai `sceneGraph`. Aizstājvārds: `prompt`.
`length`	string or number	Mērķa garums kā `"M:SS"` (`"0:30"`, `"1:00"`) vai sekundes. Pozitīvs 30 daudzkārtnis, līdz 360. Izlaidiet automātiskam garumam. Aizstājvārds: `lengthSeconds` (skaitlis).
`voice`	string	Neobligāti. Balss atsauce. Noklusējums ir standarta stāstītājs (Nora). Skatiet Balsis.
`language`	string	Neobligāti. Atbalstīts valodas kods (noklusējums `en`). Skatiet Valodas.
`aspect`	string	Neobligāti. `16:9` (noklusējums), `9:16`, vai `1:1`.
`source`	string	Neobligāti. Dokuments, raksts vai atšifrējums, ko pārvērst par skaidrojumu. Ja tas ir klāt, `input` kļūst par neobligātu norādi.
`preset`	string	Neobligāts zīmēšanas stils: `marker` (noklusējums), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Neobligāta atklāšanas aizpildīšanas tehnika: `A`, `B`, `C` (noklusējums), vai `D`.
`sceneGraph`	object	Neobligāti. Iepriekš uzrakstīts scene graph. Darbinieks izlaiž grafa ģenerēšanu un renderē to tieši, bet šis galapunkts joprojām izveido jaunu skaidrojumu un patērē zvanītāja parasto bezmaksas kvotu vai maksas plāna kvotu. Lai rediģētu esošu skaidrojumu, izmantojiet rediģēt skaidrojumu.

Atgriež skaidrojuma ierakstu: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null līdz gatavs) un sceneGraph (null līdz ģenerēts). 400 atgriežas tukšam input bez source, deformētam length vai nederīgam aspect, preset, fillMode vai language.

Iegūt skaidrojumu

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

Atgriež pilnu ierakstu: pašreizējo status, videoUrl kad ready, rediģējamo sceneGraph, versiju vēsturi (versions) un galvenās versijas ainas chunks. Trūkstošs id atgriež 404.

Uzskaitīt skaidrojumus

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

Uzskaita zvanošās atslēgas skaidrojumus, jaunākos vispirms. Ierobežots līdz atslēgas īpašniekam. limit tiek ierobežots no 1 līdz 100 (noklusējums 50). Atgriež vieglus kopsavilkumus (bez scene graph vai versijām). Pilnam ierakstam izmantojiet iegūt skaidrojumu.

Rediģēt skaidrojumu

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

Rediģējamības ķīlis. Pārvērtiet vienkāršas valodas norādījumu par mērķtiecīgu atkārtotu renderēšanu. Tiek atkārtoti renderētas tikai skartās ainas, izveidojot jaunu versiju. Atgriež 202 ar versiju rindā. Aptaujājiet iegūt skaidrojumu, līdz galvenā versija ir ready. Tas tiek pievienots esošajam video, tāpēc nepatērē vēl vienu bezmaksas video izveides vietu. Katra video pirmā atkārtotā renderēšana ir bezmaksas. Vēlākās izmanto maksas plāna minūtes, un bezmaksas kontiem tiek lūgts sākt plānu. Skaidrojumam jau jābūt ready (citādi 409).

Pieprasījuma pamatteksts

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

Atgriezt uz versiju

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

Pārvirza galvu uz agrāku gatavu versiju un atspoguļo tās grafu un video ierakstā. Mērķim jābūt ready versijai ar video (citādi 409).

Pieprasījuma pamatteksts

{ "versionId": "..." }

Tiešraides statusa straume

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

Server-Sent Events straume (text/event-stream). Atveriet vienu savienojumu, un katrs statusa pārejas jebkurā no jūsu skaidrojumiem ierodas kā event: status kadrs, lai jūs varētu atjaunināt "video gatavs" stāvokli brīdī, kad darbinieks pabeidz, nevis aptaujāt. Straume ir ierobežota līdz jūsu atslēgas īpašniekam.

Balsis

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

Stāstījuma balsu katalogs. Neobligātais ?language=<code> filtrē uz balsīm, kas ir dzimtās šai valodai. Atgriež voices (katra ar draudzīgu name, id, ko nodot kā voice, language, isDefault un atskaņojamu preview_url) plus globālo default. Skatiet Balsis.

Valodas

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

Atbalstītās stāstījuma valodas kā { code, label, native }. Katrs code ir derīgs language izveidē. Skatiet Valodas.

Konta stāvoklis

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

Atgriež videosGenerated (mūža garumā), konta image un isAdmin. Nepieciešama autentifikācija.

Norēķinu statuss

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

Nepieciešama autentifikācija un atgriež 200 gan bezmaksas, gan maksas kontiem. Bezmaksas konts atgriež plan: "free" ar videoAllowance, videosUsed un videosRemaining. Maksas konts atgriež arī planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining un bonusMinutes.

Izpildlaika konfigurācija un veselība

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

Publisks. Atgriež { "authEnforced": true }. Dzīvotspējas pārbaude ir GET /health.