API حوالہ

ہر اینڈپوائنٹ، اس کی درخواست اور جواب کی شکل کے ساتھ۔ تمام روٹس https://sketchie.ai/api کے نسبتی ہیں۔

اصول

ہر /v1/* اینڈپوائنٹ کو Authorization: Bearer sk_... ہیڈر درکار ہے۔ خرابیاں ایک error فلیگ اور ایک message کے ساتھ JSON کے طور پر واپس آتی ہیں:

خرابی کا جواب

{
  "error": true,
  "message": "length must be a positive multiple of 30 seconds, at most 360"
}

جنریشن اینڈپوائنٹ فی منٹ 20 درخواستوں تک محدود ہیں۔ باقی تمام اینڈپوائنٹ فی منٹ 200 کی حد شیئر کرتے ہیں۔

ایک وضاحتی بنائیں

POST https://sketchie.ai/api/v1/explainer

ایک جنریشن شروع کرتا ہے اور قطار میں لگے ریکارڈ کے ساتھ 202 Accepted واپس کرتا ہے۔ ready ہونے تک ایک وضاحتی حاصل کریں پول کریں۔

درخواست باڈی

{
  "input": "Explain how DNS resolves a domain name",
  "length": "0:30",
  "aspect": "16:9",
  "voice": "sketchie:sulafat",
  "language": "en"
}

فیلڈ	قسم	نوٹس
`input`	string	کیا وضاحت کرنی ہے۔ ایک مختصر پرامپٹ یا مکمل دستاویز متن۔ لازمی جب تک `source` یا `sceneGraph` موجود نہ ہو۔ عرفی نام: `prompt`۔
`length`	string or number	ہدف دورانیہ `"M:SS"` (`"0:30"`، `"1:00"`) یا سیکنڈ کے طور پر۔ 30 کا مثبت مضاعف، 360 تک۔ خودکار دورانیے کے لیے چھوڑ دیں۔ عرفی نام: `lengthSeconds` (عدد)۔
`voice`	string	اختیاری۔ ایک آواز ریف۔ طے شدہ معیاری راوی (Nora)۔ آوازیں دیکھیں۔
`language`	string	اختیاری۔ ایک معاون زبان کوڈ (طے شدہ `en`)۔ زبانیں دیکھیں۔
`aspect`	string	اختیاری۔ `16:9` (طے شدہ)، `9:16`، یا `1:1`۔
`source`	string	اختیاری۔ ایک وضاحتی میں بدلنے کے لیے ایک دستاویز، مضمون یا نقل۔ موجود ہونے پر، `input` ایک اختیاری رہنمائی بن جاتا ہے۔
`preset`	string	اختیاری ڈرائنگ انداز: `marker` (طے شدہ)، `chalkboard`، `pencil`، `blueprint`، `crayon`، `clean`۔
`fillMode`	string	اختیاری ریویل فِل تکنیک: `A`، `B`، `C` (طے شدہ)، یا `D`۔
`sceneGraph`	object	اختیاری۔ ایک پہلے سے لکھا scene graph۔ ورکر گراف جنریشن چھوڑ کر اسے براہ راست رینڈر کرتا ہے، لیکن یہ اینڈپوائنٹ پھر بھی ایک نیا وضاحتی بناتا ہے اور کال کرنے والے کا معمول کا مفت کوٹہ یا ادا شدہ پلان کوٹہ خرچ کرتا ہے۔ موجودہ وضاحتی ترمیم کرنے کے لیے ایک وضاحتی ترمیم کریں استعمال کریں۔

وضاحتی ریکارڈ واپس کرتا ہے: id، status، prompt، lengthSeconds، voice، language، aspect، videoUrl (تیار ہونے تک null) اور sceneGraph (جنریٹ ہونے تک null)۔ source کے بغیر خالی input، بدشکل length، یا غلط aspect، preset، fillMode یا language کے لیے 400 واپس آتا ہے۔

ایک وضاحتی حاصل کریں

GET https://sketchie.ai/api/v1/explainer/:id

مکمل ریکارڈ واپس کرتا ہے: موجودہ status، ready ہونے پر videoUrl، قابلِ ترمیم sceneGraph، ورژن تاریخ (versions) اور ہیڈ ورژن کے منظر chunks۔ غائب id 404 واپس کرتا ہے۔

وضاحتی فہرست کریں

GET https://sketchie.ai/api/v1/explainer?limit=50

کال کرنے والی کلید کے وضاحتی فہرست کرتا ہے، تازہ ترین پہلے۔ کلید کے مالک تک محدود۔ limit 1 سے 100 تک محدود ہوتا ہے (طے شدہ 50)۔ ہلکے خلاصے واپس کرتا ہے (کوئی scene graph یا ورژن نہیں)۔ مکمل ریکارڈ کے لیے ایک وضاحتی حاصل کریں استعمال کریں۔

ایک وضاحتی ترمیم کریں

POST https://sketchie.ai/api/v1/explainer/:id/edit

ترمیم پذیری کی کیل۔ سادہ زبان کی ہدایت کو ایک ہدف شدہ دوبارہ رینڈر میں بدلیں۔ صرف متاثرہ مناظر دوبارہ رینڈر ہوتے ہیں، ایک نیا ورژن پیدا کرتے ہیں۔ قطار میں لگے ورژن کے ساتھ 202 واپس کرتا ہے۔ ہیڈ ورژن کے ready ہونے تک ایک وضاحتی حاصل کریں پول کریں۔ یہ موجودہ ویڈیو میں شامل ہوتا ہے، لہٰذا ایک اور مفت ویڈیو بنانے کا سلاٹ خرچ نہیں کرتا۔ ہر ویڈیو کا پہلا دوبارہ رینڈر مفت ہے۔ بعد والے ادا شدہ پلان کے منٹ استعمال کرتے ہیں، اور مفت اکاؤنٹس سے ایک پلان شروع کرنے کو کہا جاتا ہے۔ وضاحتی پہلے سے ready ہونا چاہیے (ورنہ 409)۔

درخواست باڈی

{ "instruction": "Make the title scene shorter and warmer" }

ایک ورژن پر واپس کریں

POST https://sketchie.ai/api/v1/explainer/:id/revert

ہیڈ کو پہلے کے تیار ورژن پر دوبارہ اشارہ کرتا ہے اور اس کے گراف اور ویڈیو کو ریکارڈ پر آئینہ کرتا ہے۔ ہدف کو ویڈیو والا ایک ready ورژن ہونا چاہیے (ورنہ 409)۔

درخواست باڈی

{ "versionId": "..." }

لائیو حالت اسٹریم

GET https://sketchie.ai/api/v1/explainer/events

ایک Server-Sent Events اسٹریم (text/event-stream)۔ ایک کنکشن کھولیں اور آپ کے کسی بھی وضاحتی پر ہر حالت منتقلی ایک event: status فریم کے طور پر آتی ہے، تاکہ آپ پول کرنے کے بجائے ورکر کے ختم ہوتے ہی "ویڈیو تیار" حالت اپڈیٹ کر سکیں۔ اسٹریم آپ کی کلید کے مالک تک محدود ہے۔

آوازیں

GET https://sketchie.ai/api/v1/voices

بیانیہ آواز کیٹلاگ۔ اختیاری ?language=<code> اس زبان کی مقامی آوازوں تک فلٹر کرتا ہے۔ voices واپس کرتا ہے (ہر ایک میں ایک آسان name، voice کے طور پر بھیجنے کے لیے id، language، isDefault اور ایک چلانے کے قابل preview_url) نیز عالمی default۔ آوازیں دیکھیں۔

زبانیں

GET https://sketchie.ai/api/v1/languages

معاون بیانیہ زبانیں، { code, label, native } کے طور پر۔ ہر code بناتے وقت ایک درست language ہے۔ زبانیں دیکھیں۔

اکاؤنٹ حالت

GET https://sketchie.ai/api/v1/account/state

videosGenerated (تاحیات)، اکاؤنٹ image اور isAdmin واپس کرتا ہے۔ تصدیق درکار ہے۔

بلنگ حالت

GET https://sketchie.ai/api/v1/billing/status

تصدیق درکار ہے اور مفت اور ادا شدہ دونوں اکاؤنٹس کے لیے 200 واپس کرتا ہے۔ ایک مفت اکاؤنٹ videoAllowance، videosUsed اور videosRemaining کے ساتھ plan: "free" واپس کرتا ہے۔ ایک ادا شدہ اکاؤنٹ planLabel، billingInterval، trialStatus، quotaMinutes، minutesUsedThisPeriod، minutesRemaining اور bonusMinutes بھی واپس کرتا ہے۔

رن ٹائم کنفیگ اور صحت

GET https://sketchie.ai/api/config

عوامی۔ { "authEnforced": true } واپس کرتا ہے۔ ایک لائیونیس چیک GET /health پر ہے۔