CLI og SDK
@sketchie/sdk TypeScript-klienten og sketchie-kommandolinja er tynne, typa wrapperar over same HTTP-API. Begge les nøkkelen din frå SKETCHIE_API_KEY og går som standard til https://sketchie.ai/api.
SDK-en og CLI-en vert levert som ein del av Sketchie-verktøysettet. Viss registeret ditt ikkje løyser pakken enno, kan du køyre dei frå Sketchie-repositoriet med bun. Det rå HTTP-API-et fungerer i dag frå alle språk.
TypeScript SDK
Opprett ein klient, generer ei forklaring med dei venlege felta, og vent på rendringa.
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 gjenrendringssløyfa
Redigerbarheitskilen: ei ferdig forklaring returnerer sin eigen sceneGraph. Commit henne med editExplainerGraph for å leggje til ein versjon utan å bruke ein annan gratis videoopprettingsplass, eller send ein instruksjon på vanleg språk. Den fyrste gjenrendringa av kvar video er gratis. Seinare gjenrendringar bruker betalt plan-minutt.
// 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 metodar: 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 Flagg og miljø
| Flagg | Tyding |
|---|---|
--length <M:SS|sec> | Mållengd, t.d. 0:30, 1:00, eller sekund. Eit positivt multiplum av 30. Utelat for auto. |
--aspect <ratio> | 16:9 (standard), 9:16, eller 1:1. |
--voice <ref> | Ein stemme-ref (sjå sketchie voices). Valfritt; standard Nora. |
--limit <n> | Maks rader for list, 1 til 100 (standard 50). |
--wait | Spør til rendringa er ferdig eller mislukkast. |
--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. Skrivast aldri ut i utdata. |