Tổng quan và bắt đầu nhanh

Sketchie biến một prompt hoặc tài liệu thành video giải thích bảng trắng, và trả lại cho bạn cả video đã dựng lẫn scene graph có thể chỉnh sửa của nó. Đây là tài liệu tham chiếu cho HTTP API, CLI, TypeScript SDK và máy chủ MCP.

Quyền truy cập API được bao gồm trong mọi gói trả phí. Tạo khóa API từ Cài đặt trong ứng dụng khi bạn đã có gói. Việc tạo qua API rút phút từ gói của bạn với cùng mức như ứng dụng. Không có mức giá API riêng.

Xác thực

Mỗi yêu cầu được xác thực bằng khóa API của bạn dưới dạng token Bearer. Tạo một khóa trong ứng dụng ở phần Cài đặt, rồi gửi nó trong tiêu đề Authorization:

Tiêu đề yêu cầu 
Authorization: Bearer sk_...

Khóa được hiển thị một lần, khi tạo. Giữ bí mật. URL cơ sở cho mọi endpoint là https://sketchie.ai/api.

Bắt đầu nhanh

1. Tạo một video giải thích

Gửi chủ đề của bạn dưới dạng input và độ dài mục tiêu tùy chọn dưới dạng length (một chuỗi "M:SS" thân thiện như "0:30" hoặc "1:00", theo bước 30 giây). Bỏ qua length để có độ dài tự động.

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

Lệnh gọi trả về 202 Accepted ngay lập tức với một bản ghi trong hàng đợi. Việc dựng chạy ở nền và mất vài phút.

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. Thăm dò kết quả

Lấy video giải thích theo id cho đến khi status của nó đạt trạng thái kết thúc. Vòng đời là queued, rồi generating, rồi rendering, rồi ready (xong) hoặc failed.

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

Khi ở trạng thái ready, bản ghi mang URL video và scene graph có thể chỉnh sửa:

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

Tên trường thân thiện và cổ điển. input và length là các trường yêu cầu thân thiện. Các trường cũ prompt (chuỗi) và lengthSeconds (một số, bội số dương của 30) vẫn được chấp nhận làm bí danh, nên các tích hợp hiện có tiếp tục hoạt động. Khi gửi cả hai, trường thân thiện thắng.

Đi tiếp đến đâu

  • Tham chiếu API . Mọi endpoint, cùng hình dạng yêu cầu và phản hồi.
  • Giọng đọc . Người dẫn mặc định, danh mục sáu giọng, và bản xem trước có thể phát.
  • Ngôn ngữ . 34 ngôn ngữ thuyết minh được hỗ trợ.
  • CLI và SDK . Dòng lệnh sketchie và ứng dụng khách TypeScript @sketchie/sdk.
  • Thiết lập MCP . Dùng Sketchie làm công cụ trong Claude Desktop, Claude Code và ứng dụng Claude.