CLI ja SDK

@sketchie/sdk TypeScript-klient ja sketchie käsurida on õhukesed, tüübitud ümbrised sama HTTP API kohal. Mõlemad loevad teie võtme SKETCHIE_API_KEY-st ja lähevad vaikimisi aadressile https://sketchie.ai/api.

SDK ja CLI tarnitakse osana Sketchie tööriistakomplektist. Kui teie register ei lahenda veel paketti, saate need käivitada Sketchie hoidlast, kasutades bun. Toorest HTTP API-t saab täna kasutada mis tahes keelest.

TypeScript SDK

Looge klient, genereerige selgitus sõbralike väljadega ja oodake renderdamist.

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

Muutmise ja uuesti renderdamise silmus

Muudetavuse kiil: valmis selgitus tagastab oma sceneGraph. Kinnitage see editExplainerGraph-ga, et lisada versioon ilma teist tasuta video loomise kohta kasutamata, või saatke juhis lihtsas keeles. Iga video esimene uuesti renderdamine on tasuta. Hilisemad uuesti renderdamised kasutavad tasulise plaani minuteid.

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

Häälte loetlemine

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

Muud meetodid: getExplainer, listExplainers, revertExplainer, duplicateExplainer, ja deleteExplainer.

Käsurida

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

Lipud ja keskkond

LippTähendus
--length <M:SS|sec> Sihtpikkus, nt 0:30, 1:00, või sekundid. Positiivne 30 kordne. Jätke välja automaatse jaoks.
--aspect <ratio> 16:9 (vaikimisi), 9:16, või 1:1.
--voice <ref> Hääle viide (vt sketchie voices). Valikuline; vaikimisi Nora.
--limit <n> Maksimaalsed read list jaoks, 1 kuni 100 (vaikimisi 50).
--wait Pollib, kuni renderdamine lõpeb või ebaõnnestub.
--json Masinloetav väljund stdout-is.
--api-url <url> API baas-URL koos /api eesliitega. Env: SKETCHIE_API_URL.
--api-key <key> Teie API võti. Env: SKETCHIE_API_KEY. Väljundis ei prindita kunagi.