Genel bakış ve hızlı başlangıç

Sketchie bir istemi veya belgeyi beyaz tahta anlatım videosuna dönüştürür ve size hem işlenmiş videoyu hem de düzenlenebilir scene graph verisini geri verir. Bu; HTTP API, CLI, TypeScript SDK ve MCP sunucusu için referanstır.

API erişimi her ücretli planda dahildir. Bir plana geçtikten sonra uygulamadaki Ayarlar bölümünden bir API anahtarı oluşturun. API üretimleri, uygulamayla aynı oranda plan dakikalarınızı kullanır. Ayrı bir API ücreti yoktur.

Kimlik doğrulama

Her istek, API anahtarınızla Bearer belirteci olarak kimlik doğrulanır. Uygulamada Ayarlar altında bir anahtar oluşturun, ardından onu Authorization başlığında gönderin:

İstek başlığı 
Authorization: Bearer sk_...

Anahtar oluşturma sırasında bir kez gösterilir. Gizli tutun. Her uç noktanın temel URL adresi https://sketchie.ai/api şeklindedir.

Hızlı başlangıç

1. Bir anlatım videosu oluşturun

Konunuzu input olarak ve isteğe bağlı bir hedef süreyi length olarak gönderin ("0:30" veya "1:00" gibi kullanıcı dostu bir "M:SS" dizesi, 30 saniyelik adımlarla). Otomatik süre için length alanını atlayın.

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"
  }'

Çağrı, kuyruğa alınmış bir kayıtla hemen 202 Accepted döndürür. İşleme arka planda çalışır ve birkaç dakika sürer.

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. Sonucu yoklayın

Anlatım videosunu, status değeri sonlanmış bir duruma ulaşana kadar id ile getirin. Yaşam döngüsü şudur: queued, sonra generating, sonra rendering, sonra ready (bitti) veya failed.

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

ready olduğunda kayıt, video URL adresini ve düzenlenebilir scene graph verisini taşır:

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

Kullanıcı dostu ve klasik alan adları. input ve length kullanıcı dostu istek alanlarıdır. Eski prompt (dize) ve lengthSeconds (sayı, 30'un pozitif katı) hâlâ takma ad olarak kabul edilir, böylece mevcut entegrasyonlar çalışmaya devam eder. İkisi de gönderildiğinde kullanıcı dostu alan kazanır.

Bundan sonra nereye

  • API referansı . Her uç nokta, istek ve yanıt biçimleriyle.
  • Sesler . Varsayılan anlatıcı, altı sesli katalog ve oynatılabilir önizlemeler.
  • Diller . Desteklenen 34 anlatım dili.
  • CLI ve SDK . sketchie komut satırı ve @sketchie/sdk TypeScript istemcisi.
  • MCP kurulumu . Sketchie'yi Claude Desktop, Claude Code ve Claude uygulamasında araç olarak kullanın.