概览与快速开始

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 发送(一个友好的 "M:SS" 字符串,如 "0:30""1:00",以 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. 轮询结果

按 id 获取讲解视频,直到其 status 达到终止状态。生命周期是 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": [ ... ] }
}

友好的字段名与经典字段名。inputlength 是友好的请求字段。旧的 prompt(字符串)和 lengthSeconds(一个数字,30 的正整数倍)仍作为别名被接受,因此现有集成继续可用。两者都发送时,友好字段胜出。

接下来去哪里

  • API 参考 。每个端点,及其请求和响应的形态。
  • 语音 。默认旁白、六个语音目录,以及可播放的预览。
  • 语言 。支持的 34 种旁白语言。
  • CLI 与 SDK sketchie 命令行和 @sketchie/sdk TypeScript 客户端。
  • MCP 设置 。在 Claude Desktop、Claude Code 和 Claude 应用中把 Sketchie 用作工具。