CLI in SDK

Odjemalec TypeScript @sketchie/sdk in ukazna vrstica sketchie sta tanka, tipizirana ovoja nad istim HTTP API. Oba prebereta vaš ključ iz SKETCHIE_API_KEY in privzeto uporabljata https://sketchie.ai/api.

SDK in CLI se dostavljata kot del orodij Sketchie. Če vaš register še ne razreši paketa, ju lahko poženete iz repozitorija Sketchie z bun. Surovi HTTP API danes deluje iz kateregakoli jezika.

TypeScript SDK

Ustvarite odjemalca, ustvarite razlago s prijaznimi polji in počakajte na upodabljanje.

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

Zanka urejanja in ponovnega upodabljanja

Klin urejevalnosti: dokončana razlaga vrne svoj sceneGraph. Potrdite ga z editExplainerGraph, da dodate različico brez porabe drugega brezplačnega mesta za ustvarjanje videa, ali pošljite navodilo v preprostem jeziku. Prvo ponovno upodabljanje vsakega videa je brezplačno. Kasnejša ponovna upodabljanja uporabljajo minute plačljivega načrta.

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

Naštevanje glasov

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

Druge metode: getExplainer, listExplainers, revertExplainer, duplicateExplainer, in deleteExplainer.

Ukazna vrstica

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

Zastavice in okolje

ZastavicaPomen
--length <M:SS|sec> Ciljna dolžina, npr. 0:30, 1:00, ali sekunde. Pozitiven večkratnik 30. Izpustite za samodejno.
--aspect <ratio> 16:9 (privzeto), 9:16, ali 1:1.
--voice <ref> Referenca glasu (glejte sketchie voices). Neobvezno; privzeto Nora.
--limit <n> Največ vrstic za list, 1 do 100 (privzeto 50).
--wait Poizveduje, dokler se upodabljanje ne konča ali ne uspe.
--json Strojno berljiv izhod na stdout.
--api-url <url> Osnovni URL API vključno s predpono /api. Env: SKETCHIE_API_URL.
--api-key <key> Vaš API ključ. Env: SKETCHIE_API_KEY. Nikoli natisnjen v izhodu.