CLI e SDK

O cliente TypeScript @sketchie/sdk e a linha de comando sketchie são wrappers finos e tipados sobre a mesma API HTTP. Ambos leem sua chave de SKETCHIE_API_KEY e usam https://sketchie.ai/api por padrão.

O SDK e a CLI vêm como parte do toolkit da Sketchie. Se seu registry ainda não resolve o pacote, você pode rodá-los do repositório da Sketchie com bun. A API HTTP crua funciona de qualquer linguagem hoje.

SDK TypeScript

Crie um cliente, gere um explicativo com os campos amigáveis e espere o 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

O loop de edição e re-render

A cunha da editabilidade: um explicativo pronto devolve seu sceneGraph. Confirme com editExplainerGraph para acrescentar uma versão sem consumir outra criação de vídeo grátis, ou envie uma instrução em linguagem simples. O primeiro re-render de cada vídeo é grátis. Os seguintes usam minutos do plano pago.

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

Listar vozes

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

Outros métodos: getExplainer, listExplainers, revertExplainer, duplicateExplainer e deleteExplainer.

Linha de comando

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

Flags e ambiente

FlagSignificado
--length <M:SS|sec> Duração alvo, p. ex. 0:30, 1:00 ou segundos. Um múltiplo positivo de 30. Omita para automático.
--aspect <ratio> 16:9 (padrão), 9:16 ou 1:1.
--voice <ref> Um ref de voz (veja sketchie voices). Opcional; padrão Nora.
--limit <n> Máximo de linhas para list, 1 a 100 (padrão 50).
--wait Faz polling até o render terminar ou falhar.
--json Saída legível por máquina no stdout.
--api-url <url> URL base da API incluindo o prefixo /api. Env: SKETCHIE_API_URL.
--api-key <key> Sua chave de API. Env: SKETCHIE_API_KEY. Nunca impressa na saída.