Gambaran keseluruhan dan mula pantas

Sketchie menukar prompt atau dokumen menjadi video penerang papan putih, dan memulangkan kepada anda kedua-dua video yang dirender dan scene graph boleh suntingnya. Ini ialah rujukan untuk HTTP API, CLI, TypeScript SDK dan pelayan MCP.

Akses API disertakan dalam setiap pelan berbayar. Cipta kunci API daripada Tetapan dalam apl setelah anda mempunyai pelan. Penjanaan melalui API menarik minit pelan anda pada kadar yang sama seperti apl. Tiada harga API berasingan.

Pengesahan

Setiap permintaan disahkan dengan kunci API anda sebagai token Bearer. Cipta kunci dalam apl di bawah Tetapan, kemudian hantar ia dalam pengepala Authorization:

Pengepala permintaan 
Authorization: Bearer sk_...

Kunci ditunjukkan sekali, semasa penciptaan. Rahsiakan ia. URL asas untuk setiap endpoint ialah https://sketchie.ai/api.

Mula pantas

1. Cipta satu penerang

Hantar topik anda sebagai input dan panjang sasaran pilihan sebagai length (rentetan "M:SS" mesra seperti "0:30" atau "1:00", dalam langkah 30 saat). Tinggalkan length untuk panjang automatik.

Terminal 
curl -X POST https://sketchie.ai/api/v1/explainer \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "input": "Explain how DNS resolves a domain name",
    "length": "0:30"
  }'

Panggilan memulangkan 202 Accepted serta-merta dengan rekod dalam baris gilir. Pemaparan berjalan di latar belakang dan mengambil beberapa minit.

202 Accepted 
{
  "id": "10f00eee-d2d6-4a1b-b708-f0391faaa85b",
  "status": "queued",
  "prompt": "Explain how DNS resolves a domain name",
  "lengthSeconds": 30,
  "voice": "sketchie:sulafat",
  "language": "en",
  "aspect": "16:9",
  "videoUrl": null,
  "sceneGraph": null
}

2. Tinjau hasilnya

Ambil penerang mengikut id sehingga status-nya mencapai keadaan terminal. Kitaran hayat ialah queued, kemudian generating, kemudian rendering, kemudian ready (siap) atau failed.

Terminal 
curl https://sketchie.ai/api/v1/explainer/10f00eee-d2d6-4a1b-b708-f0391faaa85b \
  -H "Authorization: Bearer sk_..."

Apabila ia ready, rekod membawa URL video dan scene graph boleh sunting:

200 OK 
{
  "id": "10f00eee-d2d6-4a1b-b708-f0391faaa85b",
  "status": "ready",
  "videoUrl": "https://sketchie.ai/media/....mp4",
  "sceneGraph": { "scenes": [ ... ] }
}

Nama medan mesra dan klasik. input dan length ialah medan permintaan mesra. prompt (rentetan) dan lengthSeconds (nombor, gandaan positif 30) yang lebih lama masih diterima sebagai alias, jadi penyepaduan sedia ada terus berfungsi. Apabila kedua-duanya dihantar, medan mesra menang.

Ke mana seterusnya

  • Rujukan API . Setiap endpoint, dengan bentuk permintaan dan respons.
  • Suara . Pencerita lalai, katalog enam suara, dan pratonton boleh main.
  • Bahasa . 34 bahasa naratif yang disokong.
  • CLI dan SDK . Baris arahan sketchie dan klien TypeScript @sketchie/sdk.
  • Persediaan MCP . Gunakan Sketchie sebagai alat dalam Claude Desktop, Claude Code dan apl Claude.