CLI sy SDK
Ny mpanjifa TypeScript @sketchie/sdk sy ny command line sketchie dia fonosana manify, misy karazana amin’io HTTP API io ihany. Samy mamaky ny fanalahidinao avy amin’ny SKETCHIE_API_KEY ary mankany amin’ny https://sketchie.ai/api araka ny tsotra.
Ny SDK sy CLI dia entina ao anatin’ny fitaovana Sketchie. Raha mbola tsy mamaha ny fonosana ny rejisitranao, dia azonao atao ny mampandeha azy avy amin’ny toeram-pitehirizana Sketchie amin’ny alalan’ny bun. Ny HTTP API tsotra dia miasa amin’izao fotoana izao avy amin’ny fiteny rehetra.
TypeScript SDK
Mamorona mpanjifa, mamorona fanazavana amin’ny saha mahazatra, ary miandry ny render.
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 Ny topy fanovana sy fanaovana render indray
Ny sombiny fahafahana ovaina: ny fanazavana vita dia mamerina ny sceneGraph manokany. Ataovy commit amin’ny editExplainerGraph mba hampidirana dikanteny tsy mampiasa toeram-pamoronana horonantsary maimaimpoana hafa, na alefaso ny toromarika amin’ny fiteny tsotra. Ny fanaovana render voalohany indray amin’ny horonantsary tsirairay dia maimaimpoana. Ny fanaovana render indray manaraka dia mampiasa minitry ny drafitra andoavam-bola.
// 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); Manisa ny feo
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Fomba hafa: getExplainer, listExplainers, revertExplainer, duplicateExplainer, ary deleteExplainer.
Command line
# 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 Saina sy tontolo
| Saina | Dikany |
|---|---|
--length <M:SS|sec> | Halavana kendrena, ohatra 0:30, 1:00, na segondra. Isa mihoatra ny aotra amin’ny 30. Esory ho an’ny automatique. |
--aspect <ratio> | 16:9 (tsotra), 9:16, na 1:1. |
--voice <ref> | Fanondroana feo (jereo sketchie voices). Safidy; tsotra Nora. |
--limit <n> | Andalana faran’izay betsaka ho an’ny list, 1 ka hatramin’ny 100 (tsotra 50). |
--wait | Manara-maso mandra-pahavitan’ny render na tsy fahombiazana. |
--json | Vokatra vakian’ny milina amin’ny stdout. |
--api-url <url> | URL fototry ny API anisan’izany ny mialoha /api. Env: SKETCHIE_API_URL. |
--api-key <key> | Ny fanalahidy API-nao. Env: SKETCHIE_API_KEY. Tsy naparitaka mihitsy amin’ny vokatra. |