CLI ба SDK
@sketchie/sdk TypeScript клиент болон sketchie командын мөр нь ижил HTTP API дээрх нимгэн, төрөлжсөн боолт юм. Хоёулаа таны түлхүүрийг SKETCHIE_API_KEY-ээс уншиж, өгөгдмөлөөр https://sketchie.ai/api руу очдог.
SDK болон CLI нь Sketchie хэрэгслийн иж бүрдлийн нэг хэсэг болгон илгээгддэг. Хэрэв таны бүртгэл багцыг хараахан шийдээгүй бол та bun-ээр Sketchie репозиторыг ажиллуулж болно. Түүхий HTTP API өнөөдөр ямар ч хэлнээс ажилладаг.
TypeScript SDK
Клиент үүсгэж, найрсаг талбаруудтай тайлбар үүсгэж, рендерийг хүлээнэ үү.
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 Засварлах болон дахин рендер хийх давталт
Засварлах чадварын тавцан: дууссан тайлбар өөрийн sceneGraph-ыг буцаана. Өөр үнэгүй видео үүсгэх слот ашиглахгүйгээр хувилбар нэмэхийн тулд editExplainerGraph-ээр commit хийнэ, эсвэл энгийн хэлээр зааварчилгаа илгээнэ. Видео бүрийн эхний дахин рендер нь үнэгүй. Дараагийн дахин рендерүүд төлбөртэй төлөвлөгөөний минутыг ашиглана.
// 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); Дуу хоолойг жагсаах
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Бусад аргууд: getExplainer, listExplainers, revertExplainer, duplicateExplainer, болон deleteExplainer.
Командын мөр
# 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 Флаг ба орчин
| Флаг | Утга |
|---|---|
--length <M:SS|sec> | Зорилтот урт, жишээ нь 0:30, 1:00, эсвэл секунд. 30-ийн эерэг үржвэр. Автоматын хувьд орхино уу. |
--aspect <ratio> | 16:9 (өгөгдмөл), 9:16, эсвэл 1:1. |
--voice <ref> | Дуу хоолойн ref (sketchie voices-г үзнэ үү). Сонголттой; өгөгдмөл Nora. |
--limit <n> | list-д зориулсан хамгийн их мөр, 1-ээс 100 (өгөгдмөл 50). |
--wait | Рендер дуусах эсвэл амжилтгүй болтол лавшина. |
--json | stdout дээрх машинаар уншигдах гаралт. |
--api-url <url> | /api угтваргаар оруулсан API суурь URL. Env: SKETCHIE_API_URL. |
--api-key <key> | Таны API түлхүүр. Env: SKETCHIE_API_KEY. Гаралтад хэзээ ч хэвлэгдэхгүй. |