概要とクイックスタート

Sketchie はプロンプトやドキュメントをホワイトボード解説動画に変換し、レンダリング済みの動画とその編集可能な scene graph の両方を返します。これは HTTP API、CLI、TypeScript SDK、MCP サーバーのリファレンスです。

API アクセスはすべての有料プランに含まれています。プランに加入したら、アプリの設定から API キーを作成してください。API による生成は、アプリと同じレートでプランの分数を消費します。API の料金は別途ありません。

認証

すべてのリクエストは、API キーを Bearer トークンとして認証します。アプリの設定でキーを作成し、Authorization ヘッダーで送信してください:

リクエストヘッダー 
Authorization: Bearer sk_...

キーは作成時に一度だけ表示されます。秘密にしてください。すべてのエンドポイントのベース URL は https://sketchie.ai/api です。

クイックスタート

1. 解説動画を作成する

トピックを input として送信し、任意の目標の長さを length として送信します（"0:30" や "1:00" のような分かりやすい "M:SS" 文字列で、30 秒刻み）。自動の長さにするには length を省略します。

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

呼び出しはキューに入ったレコードとともに即座に 202 Accepted を返します。レンダリングはバックグラウンドで実行され、数分かかります。

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. 結果をポーリングする

status が終端状態に達するまで、id で解説動画を取得します。ライフサイクルは queued、次に generating、次に rendering、次に ready（完了）または failed です。

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

ready になると、レコードに動画の URL と編集可能な scene graph が含まれます:

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

分かりやすいフィールド名とクラシックなフィールド名。input と length は分かりやすいリクエストフィールドです。古い prompt（文字列）と lengthSeconds（数値、30 の正の倍数）はエイリアスとして引き続き受け付けられるため、既存の統合はそのまま動作します。両方が送信された場合は、分かりやすいフィールドが優先されます。

次に進む場所

  • API リファレンス 。各エンドポイントと、そのリクエストおよびレスポンスの形式。
  • 音声 。デフォルトのナレーター、6 種類の音声カタログ、再生可能なプレビュー。
  • 言語 。サポートされている 34 のナレーション言語。
  • CLI と SDK 。sketchie コマンドラインと @sketchie/sdk TypeScript クライアント。
  • MCP セットアップ 。Claude Desktop、Claude Code、Claude アプリで Sketchie をツールとして使用します。