نمای کلی و شروع سریع

Sketchie یک پرامپت یا سند را به یک ویدیوی توضیحی وایت‌بردی تبدیل می‌کند و هم ویدیوی رندرشده و هم scene graph قابل ویرایش آن را به شما بازمی‌گرداند. این مرجعی برای HTTP API، CLI، TypeScript SDK و سرور MCP است.

دسترسی به API در هر پلن پولی گنجانده شده است. پس از داشتن یک پلن، از تنظیمات درون برنامه یک کلید API بسازید. تولیدهای API با همان نرخ برنامه از دقایق پلن شما برداشت می‌کنند. قیمت API جداگانه‌ای وجود ندارد.

احراز هویت

هر درخواست با کلید API شما به‌عنوان توکن Bearer احراز هویت می‌شود. یک کلید در برنامه در بخش تنظیمات بسازید، سپس آن را در سرآیند Authorization بفرستید:

سرآیند درخواست 
Authorization: Bearer sk_...

کلید یک بار، هنگام ساخت، نمایش داده می‌شود. آن را محرمانه نگه دارید. URL پایه برای هر نقطه پایانی https://sketchie.ai/api است.

شروع سریع

۱. یک ویدیوی توضیحی بسازید

موضوع خود را به‌عنوان input و یک طول هدف اختیاری را به‌عنوان length بفرستید (یک رشته "M:SS" ساده مانند "0:30" یا "1:00"، در گام‌های ۳۰ ثانیه‌ای). برای طول خودکار 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
}

۲. نتیجه را نظرسنجی کنید

ویدیوی توضیحی را با 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 (یک عدد، مضرب مثبت ۳۰) همچنان به‌عنوان نام مستعار پذیرفته می‌شوند، بنابراین یکپارچه‌سازی‌های موجود کار می‌کنند. وقتی هر دو فرستاده شوند، فیلد ساده برنده است.

در ادامه کجا بروید

  • مرجع API . هر نقطه پایانی، با شکل‌های درخواست و پاسخ.
  • صداها . راوی پیش‌فرض، کاتالوگ شش صدا و پیش‌نمایش‌های قابل پخش.
  • زبان‌ها . ۳۴ زبان روایت پشتیبانی‌شده.
  • CLI و SDK . خط فرمان sketchie و کلاینت TypeScript به نام @sketchie/sdk.
  • راه‌اندازی MCP . از Sketchie به‌عنوان ابزار در Claude Desktop، Claude Code و برنامه Claude استفاده کنید.