نظرة عامة والبدء السريع

يحوّل 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 وعميل @sketchie/sdk بلغة TypeScript.
  • إعداد MCP . استخدم Sketchie كأدوات في Claude Desktop وClaude Code وتطبيق Claude.