CLI a SDK

Klient TypeScript @sketchie/sdk a príkazový riadok sketchie sú tenké, typované obaly nad rovnakým HTTP API. Oba čítajú váš kľúč z SKETCHIE_API_KEY a predvolene smerujú na https://sketchie.ai/api.

SDK a CLI sa dodávajú ako súčasť sady nástrojov Sketchie. Ak váš register ešte nerozpoznáva balík, môžete ich spustiť z repozitára Sketchie pomocou bun. Surové HTTP API dnes funguje z akéhokoľvek jazyka.

TypeScript SDK

Vytvorte klienta, vygenerujte vysvetlenie pomocou priateľských polí a počkajte na render.

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

Slučka úprav a opätovného renderu

Klin upraviteľnosti: dokončené vysvetlenie vracia svoj sceneGraph. Potvrďte ho pomocou editExplainerGraph na pridanie verzie bez spotrebovania ďalšieho slotu na bezplatné vytvorenie videa, alebo pošlite inštrukciu v bežnom jazyku. Prvý opätovný render každého videa je zadarmo. Neskoršie opätovné rendery používajú minúty plateného plánu.

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);

Výpis hlasov

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

Ďalšie metódy: getExplainer, listExplainers, revertExplainer, duplicateExplainer, a deleteExplainer.

Príkazový riadok

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

Príznaky a prostredie

PríznakVýznam
--length <M:SS|sec> Cieľová dĺžka, napr. 0:30, 1:00, alebo sekundy. Kladný násobok 30. Vynechajte pre automatický.
--aspect <ratio> 16:9 (predvolené), 9:16, alebo 1:1.
--voice <ref> Odkaz na hlas (pozri sketchie voices). Voliteľné; predvolené Nora.
--limit <n> Maximálne riadky pre list, 1 až 100 (predvolené 50).
--wait Dotazuje sa, kým sa render nedokončí alebo nezlyhá.
--json Strojovo čitateľný výstup na stdout.
--api-url <url> Základná URL API vrátane predpony /api. Env: SKETCHIE_API_URL.
--api-key <key> Váš API kľúč. Env: SKETCHIE_API_KEY. Nikdy sa nevypisuje vo výstupe.