API nuoroda

Kiekvienas galinis taškas su jo užklausos ir atsakymo forma. Visi maršrutai yra santykiniai su https://sketchie.ai/api.

Susitarimai

Kiekvienam /v1/* galiniam taškui reikia antraštės Authorization: Bearer sk_.... Klaidos grįžta kaip JSON su vėliavėle error ir message:

Klaidos atsakymas

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

Generavimo galiniai taškai apriboti iki 20 užklausų per minutę. Visi kiti galiniai taškai dalijasi 200 per minutę riba.

Sukurti aiškinimą

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

Pradeda generavimą ir grąžina 202 Accepted su įrašu eilėje. Apklauskite gauti aiškinimą, kol jis bus ready.

Užklausos kūnas

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

Laukas	Tipas	Pastabos
`input`	string	Ką paaiškinti. Trumpa užklausa arba visas dokumento tekstas. Privaloma, nebent yra `source` arba `sceneGraph`. Pseudonimas: `prompt`.
`length`	string or number	Tikslinis ilgis kaip `"M:SS"` (`"0:30"`, `"1:00"`) arba sekundės. Teigiamas 30 kartotinis, iki 360. Praleiskite automatiniam ilgiui. Pseudonimas: `lengthSeconds` (skaičius).
`voice`	string	Neprivaloma. Balso nuoroda. Numatytasis standartinis pasakotojas (Nora). Žr. Balsai.
`language`	string	Neprivaloma. Palaikomas kalbos kodas (numatytasis `en`). Žr. Kalbos.
`aspect`	string	Neprivaloma. `16:9` (numatytasis), `9:16`, arba `1:1`.
`source`	string	Neprivaloma. Dokumentas, straipsnis ar nuorašas, kurį reikia paversti aiškinimu. Kai yra, `input` tampa neprivalomu nurodymu.
`preset`	string	Neprivalomas piešimo stilius: `marker` (numatytasis), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Neprivaloma atskleidimo užpildymo technika: `A`, `B`, `C` (numatytasis), arba `D`.
`sceneGraph`	object	Neprivaloma. Iš anksto parašytas scene graph. Darbuotojas praleidžia grafo generavimą ir atvaizduoja jį tiesiogiai, bet šis galinis taškas vis tiek sukuria naują aiškinimą ir sunaudoja skambinančiojo įprastą nemokamą kvotą arba mokamo plano kvotą. Norėdami redaguoti esamą aiškinimą, naudokite redaguoti aiškinimą.

Grąžina aiškinimo įrašą: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null iki paruošimo) ir sceneGraph (null iki sugeneravimo). 400 grįžta tuščiam input be source, netaisyklingam length arba netinkamam aspect, preset, fillMode ar language.

Gauti aiškinimą

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

Grąžina visą įrašą: dabartinį status, videoUrl kai ready, redaguojamą sceneGraph, versijų istoriją (versions) ir pagrindinės versijos scenos chunks. Trūkstamas id grąžina 404.

Aiškinimų sąrašas

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

Išvardija skambinančiojo rakto aiškinimus, naujausius pirmiausia. Apribota rakto savininku. limit apribojamas nuo 1 iki 100 (numatytasis 50). Grąžina lengvas santraukas (be scene graph ar versijų). Visam įrašui naudokite gauti aiškinimą.

Redaguoti aiškinimą

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

Redaguojamumo pleištas. Paverskite paprastos kalbos nurodymą tiksliniu perrendinimu. Iš naujo atvaizduojamos tik paveiktos scenos, sukuriant naują versiją. Grąžina 202 su versija eilėje. Apklauskite gauti aiškinimą, kol pagrindinė versija bus ready. Tai pridedama prie esamo vaizdo įrašo, todėl nesunaudoja kitos nemokamo vaizdo įrašo kūrimo vietos. Pirmasis kiekvieno vaizdo įrašo perrendinimas yra nemokamas. Vėlesni naudoja mokamo plano minutes, o nemokamų paskyrų prašoma pradėti planą. Aiškinimas jau turi būti ready (kitaip 409).

Užklausos kūnas

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

Atkurti į versiją

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

Nukreipia galvą į ankstesnę paruoštą versiją ir atspindi jos grafą ir vaizdo įrašą į įrašą. Tikslas turi būti ready versija su vaizdo įrašu (kitaip 409).

Užklausos kūnas

{ "versionId": "..." }

Tiesioginis būsenos srautas

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

Server-Sent Events srautas (text/event-stream). Atidarykite vieną ryšį, ir kiekvienas būsenos perėjimas bet kuriame iš jūsų aiškinimų atkeliauja kaip event: status kadras, kad galėtumėte atnaujinti "vaizdo įrašas paruoštas" būseną tą akimirką, kai darbuotojas baigia, užuot apklausę. Srautas apribotas jūsų rakto savininku.

Balsai

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

Pasakojimo balsų katalogas. Neprivalomas ?language=<code> filtruoja tai kalbai gimtus balsus. Grąžina voices (kiekvienas su patogiu name, id perduoti kaip voice, language, isDefault ir grojama preview_url) plius globalų default. Žr. Balsai.

Kalbos

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

Palaikomos pasakojimo kalbos kaip { code, label, native }. Kiekvienas code yra galiojantis language kuriant. Žr. Kalbos.

Paskyros būsena

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

Grąžina videosGenerated (viso gyvenimo), paskyros image ir isAdmin. Reikia autentifikacijos.

Atsiskaitymo būsena

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

Reikia autentifikacijos ir grąžina 200 tiek nemokamoms, tiek mokamoms paskyroms. Nemokama paskyra grąžina plan: "free" su videoAllowance, videosUsed ir videosRemaining. Mokama paskyra taip pat grąžina planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining ir bonusMinutes.

Vykdymo laiko konfigūracija ir būklė

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

Vieša. Grąžina { "authEnforced": true }. Gyvybingumo patikra yra GET /health.