ภาพรวมและเริ่มต้นอย่างรวดเร็ว

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": [ ... ] }
}

ชื่อฟิลด์ที่ใช้ง่ายและแบบดั้งเดิม input และ length คือฟิลด์คำขอที่ใช้ง่าย ฟิลด์เก่า prompt (สตริง) และ lengthSeconds (ตัวเลข พหุคูณบวกของ 30) ยังถูกรับเป็นชื่อแทน ดังนั้นการผสานรวมที่มีอยู่ยังทำงานต่อไป เมื่อส่งทั้งสอง ฟิลด์ที่ใช้ง่ายจะชนะ

ไปที่ไหนต่อ

  • การอ้างอิง API . ทุกเอนด์พอยต์ พร้อมรูปแบบคำขอและการตอบกลับ
  • เสียง . ผู้บรรยายเริ่มต้น แคตตาล็อกหกเสียง และตัวอย่างที่เล่นได้
  • ภาษา . 34 ภาษาบรรยายที่รองรับ
  • CLI และ SDK . บรรทัดคำสั่ง sketchie และไคลเอนต์ TypeScript @sketchie/sdk
  • การตั้งค่า MCP . ใช้ Sketchie เป็นเครื่องมือใน Claude Desktop, Claude Code และแอป Claude