CLI și SDK

Clientul TypeScript @sketchie/sdk și linia de comandă sketchie sunt wrappere subțiri, tipizate peste același API HTTP. Ambele citesc cheia dvs. din SKETCHIE_API_KEY și implicit merg la https://sketchie.ai/api.

SDK-ul și CLI-ul sunt livrate ca parte a setului de instrumente Sketchie. Dacă registrul dvs. nu rezolvă încă pachetul, îl puteți rula din depozitul Sketchie cu bun. API-ul HTTP brut funcționează astăzi din orice limbaj.

SDK TypeScript

Creați un client, generați o explicație cu câmpurile prietenoase și așteptați randarea.

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

Bucla de editare și re-randare

Pana de editabilitate: o explicație finalizată returnează propriul său sceneGraph. Confirmați-l cu editExplainerGraph pentru a adăuga o versiune fără a consuma un alt slot de creare video gratuit, sau trimiteți o instrucțiune în limbaj simplu. Prima re-randare a fiecărui videoclip este gratuită. Re-randările ulterioare folosesc minute din planul plătit.

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

Listarea vocilor

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

Alte metode: getExplainer, listExplainers, revertExplainer, duplicateExplainer, și deleteExplainer.

Linie de comandă

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

Flaguri și mediu

FlagSemnificație
--length <M:SS|sec> Durata țintă, de ex. 0:30, 1:00, sau secunde. Un multiplu pozitiv de 30. Omiteți pentru automat.
--aspect <ratio> 16:9 (implicit), 9:16, sau 1:1.
--voice <ref> O referință vocală (vedeți sketchie voices). Opțional; implicit Nora.
--limit <n> Rânduri maxime pentru list, 1 până la 100 (implicit 50).
--wait Interoghează până când randarea se termină sau eșuează.
--json Ieșire lizibilă de mașină pe stdout.
--api-url <url> URL de bază al API-ului inclusiv prefixul /api. Env: SKETCHIE_API_URL.
--api-key <key> Cheia dvs. API. Env: SKETCHIE_API_KEY. Niciodată tipărită în ieșire.