CLI ak SDK
Kliyan TypeScript @sketchie/sdk ak liy kòmand sketchie a se envlòp mens, ki gen tip sou menm API HTTP la. Toude li kle ou nan SKETCHIE_API_KEY e pa default ale nan https://sketchie.ai/api.
SDK ak CLI la vwayaje kòm yon pati nan zouti Sketchie a. Si rejis ou pa rezoud pakè a ankò, ou ka kouri yo apati depo Sketchie a ak bun. API HTTP brit la fonksyone jodi a nan nenpòt lang.
TypeScript SDK
Kreye yon kliyan, jenere yon eksplikasyon ak jaden zanmitay yo, epi tann render la.
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 Bouk edisyon ak re-render la
Kwen editabilite a: yon eksplikasyon fini retounen pwòp sceneGraph li. Commit li ak editExplainerGraph pou ajoute yon vèsyon san konsome yon lòt plas kreyasyon videyo gratis, oswa voye yon enstriksyon nan lang senp. Premye re-render chak videyo se gratis. Re-render apre yo itilize minit plan peye.
// 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); Lis vwa yo
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Lòt metòd: getExplainer, listExplainers, revertExplainer, duplicateExplainer, ak deleteExplainer.
Liy kòmand
# 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 Drapo ak anviwònman
| Drapo | Siyifikasyon |
|---|---|
--length <M:SS|sec> | Longè sib, pa egzanp 0:30, 1:00, oswa segond. Yon miltip pozitif de 30. Sote pou automatik. |
--aspect <ratio> | 16:9 (default), 9:16, oswa 1:1. |
--voice <ref> | Yon voice ref (gade sketchie voices). Opsyonèl; default Nora. |
--limit <n> | Ranje maksimòm pou list, 1 rive 100 (default 50). |
--wait | Sondaj jiskaske render la fini oswa echwe. |
--json | Sòti li kapab li pa machin sou stdout. |
--api-url <url> | URL debaz API ki gen ladan prefiks /api. Env: SKETCHIE_API_URL. |
--api-key <key> | Kle API ou a. Env: SKETCHIE_API_KEY. Pa janm enprime nan sòti a. |