API-referanse

Hvert endepunkt, med formen på forespørselen og svaret. Alle ruter er relative til https://sketchie.ai/api.

Konvensjoner

Hvert /v1/*-endepunkt krever Authorization: Bearer sk_...-headeren. Feil kommer tilbake som JSON med et error-flagg og et message:

Feilrespons

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

Genererings-endepunkter er hastighetsbegrenset til 20 forespørsler per minutt. Alle andre endepunkter deler en grense på 200 per minutt.

Opprett en forklaring

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

Starter en generering og returnerer 202 Accepted med den køede posten. Poll hent en forklaring til den er ready.

Forespørselskropp

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

Felt	Type	Notater
`input`	string	Hva som skal forklares. En kort prompt eller full dokumenttekst. Påkrevd med mindre `source` eller `sceneGraph` er til stede. Alias: `prompt`.
`length`	string or number	Mållengde som `"M:SS"` (`"0:30"`, `"1:00"`) eller sekunder. Et positivt multiplum av 30, opptil 360. Utelat for automatisk lengde. Alias: `lengthSeconds` (tall).
`voice`	string	Valgfritt. En stemme-ref. Standard er standardfortelleren (Nora). Se Stemmer.
`language`	string	Valgfritt. En støttet språkkode (standard `en`). Se Språk.
`aspect`	string	Valgfritt. `16:9` (standard), `9:16`, eller `1:1`.
`source`	string	Valgfritt. Et dokument, en artikkel eller et transkript som skal gjøres om til en forklaring. Når det er til stede, blir `input` valgfri veiledning.
`preset`	string	Valgfri tegnestil: `marker` (standard), `chalkboard`, `pencil`, `blueprint`, `crayon`, `clean`.
`fillMode`	string	Valgfri avsløringsfyllteknikk: `A`, `B`, `C` (standard), eller `D`.
`sceneGraph`	object	Valgfritt. En forhåndsskrevet scene graph. Workeren hopper over grafgenerering og renderer den direkte, men dette endepunktet oppretter fortsatt en ny forklaring og forbruker kallerens normale gratiskvote eller betalt-plan-kvote. For å redigere en eksisterende forklaring, bruk rediger en forklaring.

Returnerer forklaringsposten: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null til klar) og sceneGraph (null til generert). Et 400 kommer tilbake for en tom input uten source, en misdannet length, eller en ugyldig aspect, preset, fillMode eller language.

Hent en forklaring

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

Returnerer hele posten: nåværende status, videoUrl når ready, den redigerbare sceneGraph, versjonshistorikken (versions) og hovedversjonens scene-chunks. En manglende id returnerer 404.

List forklaringer

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

Lister den kallende nøkkelens forklaringer, nyeste først. Begrenset til nøkkelens eier. limit klemmes til 1 til 100 (standard 50). Returnerer lette sammendrag (ingen scene graph eller versjoner). Bruk hent en forklaring for hele posten.

Rediger en forklaring

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

Redigerbarhetens kile. Gjør en instruksjon i vanlig språk om til en målrettet gjengivelse på nytt. Bare de berørte scenene gjengis på nytt, og produserer en ny versjon. Returnerer 202 med den køede versjonen. Poll hent en forklaring til hovedversjonen er ready. Dette føyes til den eksisterende videoen, så det forbruker ikke en ekstra gratis-video-opprettelsesplass. Den første gjengivelsen på nytt av hver video er gratis. Senere bruker betalt-plan-minutter, og gratiskontoer blir bedt om å starte en plan. Forklaringen må allerede være ready (ellers 409).

Forespørselskropp

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

Tilbakestill til en versjon

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

Peker hodet om til en tidligere klar versjon og speiler dens graf og video til posten. Målet må være en ready-versjon med en video (ellers 409).

Forespørselskropp

{ "versionId": "..." }

Live statusstrøm

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

En Server-Sent Events-strøm (text/event-stream). Åpne én tilkobling og hver statusovergang på noen av forklaringene dine kommer som en event: status-ramme, slik at du kan oppdatere en "video klar"-tilstand i det øyeblikket workeren blir ferdig i stedet for å polle. Strømmen er begrenset til nøkkelens eier.

Stemmer

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

Fortellerstemme-katalogen. Det valgfrie ?language=<code> filtrerer til stemmer som er hjemmehørende i det språket. Returnerer voices (hver med et vennlig name, id å sende som voice, language, isDefault og en spillbar preview_url) pluss den globale default. Se Stemmer.

Språk

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

De støttede fortellerspråkene, som { code, label, native }. Hver code er et gyldig language ved opprettelse. Se Språk.

Kontostatus

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

Returnerer videosGenerated (livstid), kontoens image og isAdmin. Krever autentisering.

Faktureringsstatus

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

Krever autentisering og returnerer 200 for både gratis og betalte kontoer. En gratiskonto returnerer plan: "free" med videoAllowance, videosUsed og videosRemaining. En betalt konto returnerer også planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining og bonusMinutes.

Kjøretidskonfigurasjon og helse

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

Offentlig. Returnerer { "authEnforced": true }. En livssjekk finnes på GET /health.