CLI eta SDK
@sketchie/sdk TypeScript bezeroa eta sketchie komando-lerroa HTTP API beraren gaineko bilgarri mehe eta tipizatuak dira. Biek zure gakoa irakurtzen dute SKETCHIE_API_KEY-tik eta lehenetsi gisa https://sketchie.ai/api erabiltzen dute.
SDK eta CLI Sketchie tresna-multzoaren parte gisa bidaltzen dira. Zure erregistroak oraindik paketea ebazten ez badu, bun erabiliz Sketchie biltegitik exekutatu ditzakezu. HTTP API gordina gaur edozein hizkuntzatatik funtzionatzen du.
TypeScript SDK
Sortu bezero bat, sortu azalpen bat eremu adiskidetsuekin, eta itxaron errendatzeari.
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 Editatzeko eta berriz errendatzeko begizta
Editagarritasun ziria: amaitutako azalpen batek bere sceneGraph itzultzen du. Berretsi editExplainerGraph-ekin bertsio bat gehitzeko doako beste bideo-sorkuntza toki bat erabili gabe, edo bidali argibide bat hizkuntza arruntean. Bideo bakoitzaren lehen berriz errendatzea doakoa da. Beranduagoko berriz errendatzeek ordaindutako planaren minutuak erabiltzen dituzte.
// 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); Ahotsak zerrendatzea
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Beste metodo batzuk: getExplainer, listExplainers, revertExplainer, duplicateExplainer, eta deleteExplainer.
Komando-lerroa
# 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 Banderak eta ingurunea
| Bandera | Esanahia |
|---|---|
--length <M:SS|sec> | Helburuko luzera, adib. 0:30, 1:00, edo segundoak. 30en multiplo positiboa. Utzi kanpoan automatikorako. |
--aspect <ratio> | 16:9 (lehenetsia), 9:16, edo 1:1. |
--voice <ref> | Ahots-erreferentzia bat (ikus sketchie voices). Aukerakoa; lehenetsia Nora. |
--limit <n> | list-erako gehienezko errenkadak, 1etik 100era (lehenetsia 50). |
--wait | Galdetzen du errendatzea amaitu edo huts egin arte. |
--json | Makinak irakurtzeko irteera stdout-en. |
--api-url <url> | API oinarrizko URLa, /api aurrizkia barne. Env: SKETCHIE_API_URL. |
--api-key <key> | Zure API gakoa. Env: SKETCHIE_API_KEY. Inoiz ez da irteeran inprimatzen. |