Ikhtisar dan mulai cepat

Sketchie mengubah prompt atau dokumen menjadi video penjelas papan tulis, dan mengembalikan baik video hasil render maupun scene graph-nya yang bisa diedit. Ini adalah referensi untuk API HTTP, CLI, SDK TypeScript, dan server MCP.

Akses API termasuk di setiap paket berbayar. Buat kunci API dari Pengaturan di aplikasi begitu Anda punya paket. Pembuatan via API menarik menit paket Anda dengan tarif yang sama seperti aplikasi. Tidak ada harga API terpisah.

Autentikasi

Setiap permintaan diautentikasi dengan kunci API Anda sebagai token Bearer. Buat kunci di aplikasi pada Pengaturan, lalu kirimkan pada header Authorization:

Header permintaan 
Authorization: Bearer sk_...

Kunci ditampilkan sekali, saat pembuatan. Rahasiakan. URL dasar setiap endpoint adalah https://sketchie.ai/api.

Mulai cepat

1. Buat sebuah penjelas

Kirim topik Anda sebagai input dan durasi target opsional sebagai length (string ramah "M:SS" seperti "0:30" atau "1:00", dalam langkah 30 detik). Hilangkan length untuk durasi otomatis.

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 mengembalikan 202 Accepted secara langsung dengan catatan yang mengantre. Render berjalan di latar belakang dan butuh beberapa menit.

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. Pantau hasilnya

Ambil penjelas berdasarkan id sampai status-nya mencapai keadaan terminal. Siklus hidupnya adalah queued, lalu generating, lalu rendering, lalu ready (selesai) atau failed.

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

Saat ready, catatannya membawa URL video dan scene graph yang bisa diedit:

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

Nama field yang ramah dan klasik. input dan length adalah field permintaan yang ramah. Field lama prompt (string) dan lengthSeconds (angka, kelipatan positif 30) masih diterima sebagai alias, jadi integrasi yang ada tetap bekerja. Bila keduanya dikirim, field ramah yang menang.

Ke mana selanjutnya

  • Referensi API . Setiap endpoint, dengan bentuk permintaan dan respons.
  • Suara . Narator bawaan, katalog enam suara, dan pratinjau yang bisa diputar.
  • Bahasa . 34 bahasa narasi yang didukung.
  • CLI dan SDK . Baris perintah sketchie dan klien TypeScript @sketchie/sdk.
  • Penyiapan MCP . Gunakan Sketchie sebagai alat di Claude Desktop, Claude Code, dan aplikasi Claude.