CLI og SDK

@sketchie/sdk TypeScript-klienten og sketchie-kommandolinjen er tynne, typede wrappere over samme HTTP-API. Begge leser nøkkelen din fra SKETCHIE_API_KEY og går som standard til https://sketchie.ai/api.

SDK-en og CLI-en leveres som en del av Sketchie-verktøysettet. Hvis registeret ditt ennå ikke løser pakken, kan du kjøre dem fra Sketchie-repositoriet med bun. Det rå HTTP-API-et fungerer i dag fra ethvert språk.

TypeScript SDK

Opprett en klient, generer en forklaring med de vennlige feltene, og vent på rendret.

sketchie.ts
import { SketchieClient } from '@sketchie/sdk';

const client = new SketchieClient({
  apiKey: process.env.SKETCHIE_API_KEY, // Bearer sk_...
  // baseUrl defaults to https://sketchie.ai/api
});

// Friendly fields: input (the topic) and length ("M:SS", a multiple of 30).
const created = await client.createExplainer({
  input: 'Explain how DNS resolves a domain name',
  length: '0:30',
  aspect: '16:9',
});

// Poll until the render finishes (or fails).
const done = await client.waitForExplainer(created.id, {
  onUpdate: (e) => console.log(e.status),
});

console.log(done.videoUrl);   // the rendered MP4
console.log(done.sceneGraph); // the editable scene graph

Rediger- og gjenrenderingssløyfen

Redigerbarhetskilen: en ferdig forklaring returnerer sin egen sceneGraph. Committ den med editExplainerGraph for å legge til en versjon uten å bruke enda en gratis videoopprettingsplass, eller send en instruksjon på vanlig språk. Den første gjenrenderingen av hver video er gratis. Senere gjenrenderinger bruker betalt plan-minutter.

edit.ts
// After a video is ready you get back its editable sceneGraph.
// Edit it, then append a new version to the existing explainer.
const edited = editScenes(done.sceneGraph!); // your UI edits the graph
const rerender = await client.editExplainerGraph(done.id, edited);
await client.waitForVersion(done.id, rerender.id);

// Or apply a plain-language instruction (a targeted re-render):
const version = await client.editExplainer(done.id, 'make scene 2 shorter');
await client.waitForVersion(done.id, version.id);

Liste stemmer

voices.ts
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }]

Andre metoder: getExplainer, listExplainers, revertExplainer, duplicateExplainer, og deleteExplainer.

Kommandolinje

Terminal
# Discover voices
sketchie voices

# Generate (returns the queued record immediately)
sketchie generate "Explain how DNS resolves a domain name" --length 0:30 --aspect 16:9

# Generate and wait for the finished render
sketchie generate "Explain how DNS resolves" --length 1:00 --wait

# Status of an existing explainer
sketchie status <id>

# Conversational edit (a targeted re-render)
sketchie edit <id> "make the title scene shorter" --wait

# List your explainers
sketchie list --limit 20

Flagg og miljø

FlaggBetydning
--length <M:SS|sec> Mållengde, f.eks. 0:30, 1:00, eller sekunder. Et positivt multiplum av 30. Utelat for auto.
--aspect <ratio> 16:9 (standard), 9:16, eller 1:1.
--voice <ref> En stemme-ref (se sketchie voices). Valgfritt; standard Nora.
--limit <n> Maks rader for list, 1 til 100 (standard 50).
--wait Poller til rendret er ferdig eller mislykkes.
--json Maskinlesbar utdata på stdout.
--api-url <url> API-basis-URL inkludert /api-prefikset. Env: SKETCHIE_API_URL.
--api-key <key> API-nøkkelen din. Env: SKETCHIE_API_KEY. Skrives aldri ut i utdata.