CLI na SDK

Mteja wa TypeScript @sketchie/sdk na mstari wa amri wa sketchie ni wrapper nyembamba, zenye aina juu ya API sawa ya HTTP. Zote mbili husoma ufunguo wako kutoka SKETCHIE_API_KEY na huenda kwa chaguo-msingi kwa https://sketchie.ai/api.

SDK na CLI hutolewa kama sehemu ya seti ya zana za Sketchie. Ikiwa rejista yako bado haijatambua kifurushi, unaweza kuziendesha kutoka hazina ya Sketchie kwa bun. HTTP API mbichi inafanya kazi leo kutoka lugha yoyote.

SDK ya TypeScript

Unda mteja, tengeneza maelezo na sehemu za kirafiki, na subiri utoaji.

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

Kitanzi cha kuhariri na kutoa upya

Kabari ya uhaririwaji: maelezo yaliyokamilika hurejesha sceneGraph yake. Iandike kwa editExplainerGraph ili kuongeza toleo bila kutumia nafasi nyingine ya uundaji wa video bila malipo, au tuma maagizo kwa lugha rahisi. Utoaji upya wa kwanza wa kila video ni bure. Utoaji upya wa baadaye hutumia dakika za mpango wa kulipia.

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

Kuorodhesha sauti

voices.ts

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

Mbinu nyingine: getExplainer, listExplainers, revertExplainer, duplicateExplainer, na deleteExplainer.

Mstari wa amri

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

Bendera na mazingira

Bendera	Maana
`--length <M:SS\|sec>`	Urefu lengwa, mfano `0:30`, `1:00`, au sekunde. Kizidishi chanya cha 30. Acha kwa otomatiki.
`--aspect <ratio>`	`16:9` (chaguo-msingi), `9:16`, au `1:1`.
`--voice <ref>`	Rejeleo la sauti (ona `sketchie voices`). Hiari; chaguo-msingi Nora.
`--limit <n>`	Safu za juu zaidi kwa `list`, 1 hadi 100 (chaguo-msingi 50).
`--wait`	Huchunguza hadi utoaji ukamilike au ushindwe.
`--json`	Matokeo yanayosomeka na mashine kwenye stdout.
`--api-url <url>`	URL msingi ya API ikijumuisha kiambishi `/api`. Env: `SKETCHIE_API_URL`.
`--api-key <key>`	Ufunguo wako wa API. Env: `SKETCHIE_API_KEY`. Haiwahi kuchapishwa katika matokeo.