CLI og SDK
@sketchie/sdk TypeScript-klienten og sketchie-kommandolinjen er tynde, typede wrappere over samme HTTP-API. Begge læser din nøgle fra SKETCHIE_API_KEY og går som standard til https://sketchie.ai/api.
SDK og CLI leveres som en del af Sketchie-værktøjssættet. Hvis dit register endnu ikke løser pakken, kan du køre dem fra Sketchie-repositoriet med bun. Den rå HTTP-API virker i dag fra ethvert sprog.
TypeScript SDK
Opret en klient, generer en forklaring med de venlige felter, og vent på renderingen.
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 gen-renderingsløkken
Redigerbarhedskilen: en færdig forklaring returnerer sin sceneGraph. Commit den med editExplainerGraph for at tilføje en version uden at bruge endnu en gratis videooprettelsesplads, eller send en instruktion i almindeligt sprog. Den første gen-rendering af hver video er gratis. Senere gen-renderinger bruger betalt plan-minutter.
// 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
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Andre metoder: getExplainer, listExplainers, revertExplainer, duplicateExplainer, og deleteExplainer.
Kommandolinje
# 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 Flag og miljø
| Flag | Betydning |
|---|---|
--length <M:SS|sec> | Mållængde, f.eks. 0:30, 1:00, eller sekunder. Et positivt multiplum af 30. Udelad for auto. |
--aspect <ratio> | 16:9 (standard), 9:16, eller 1:1. |
--voice <ref> | En stemme-ref (se sketchie voices). Valgfri; standard Nora. |
--limit <n> | Maks. rækker for list, 1 til 100 (standard 50). |
--wait | Poller indtil renderingen er færdig eller fejler. |
--json | Maskinlæsbar output på stdout. |
--api-url <url> | API-basis-URL inklusive /api-præfikset. Env: SKETCHIE_API_URL. |
--api-key <key> | Din API-nøgle. Env: SKETCHIE_API_KEY. Udskrives aldrig i output. |