د API حواله

هر endpoint، د هغې د غوښتنې او ځواب شکل سره. ټول لارې د https://sketchie.ai/api پورې اړوند دي.

کنوانسیونونه

هر /v1/* endpoint د Authorization: Bearer sk_... سرلیک ته اړتیا لري. تېروتنې د error بیرغ او message سره د JSON په توګه راستنیږي:

د تېروتنې ځواب

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

د جوړولو endpoint په هره دقیقه کې 20 غوښتنو ته محدود دي. نور ټول endpoint په هره دقیقه کې د 200 حد شریکوي.

تشریح جوړ کړئ

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

جوړول پیل کوي او د کتار په ریکارډ سره 202 Accepted راستنوي. تر هغه چې ready شي تشریح ترلاسه کړئ poll کړئ.

د غوښتنې بدن

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

ساحه	ډول	یادښتونه
`input`	string	څه تشریح کول. یو لنډ prompt یا د سند بشپړ متن. اړین دی پرته لدې چې `source` یا `sceneGraph` شتون ولري. تخلص: `prompt`.
`length`	string or number	موخه اوږدوالی د `"M:SS"` (`"0:30"`, `"1:00"`) یا ثانیو په توګه. د 30 مثبت مضرب، تر 360 پورې. د اتومات اوږدوالي لپاره پریږدئ. تخلص: `lengthSeconds` (شمیر).
`voice`	string	اختیاري. د غږ ref. ډیفالټ معیاري داستان ویونکی (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. worker د ګراف جوړول پریږدي او په مستقیم ډول یې render کوي، مګر دا endpoint لاهم یو نوی تشریح جوړوي او د غږ کوونکي عادي وړیا کوټه یا د تادیه شوي پلان کوټه مصرفوي. د موجود تشریح سمولو لپاره، تشریح سم کړئ وکاروئ.

د تشریح ریکارډ راستنوي: 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 پورې clamp کیږي (ډیفالټ 50). سپک لنډیزونه راستنوي (هیڅ scene graph یا نسخې نشته). د بشپړ ریکارډ لپاره تشریح ترلاسه کړئ وکاروئ.

تشریح سم کړئ

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

د سمون وړتیا کنډول. ساده ژبه لارښوونه یو هدف شوي بیا-render ته واړوئ. یوازې اغیزمن صحنې بیا render کیږي، یو نوی نسخه تولیدوي. د کتار په نسخه سره 202 راستنوي. تر هغه چې د سر نسخه ready شي تشریح ترلاسه کړئ poll کړئ. دا موجود ویډیو ته اضافه کیږي، نو د بلې وړیا-ویډیو جوړولو ځای نه مصرفوي. د هر ویډیو لومړی بیا-render وړیا دی. وروستني د تادیه شوي پلان دقیقې کاروي، او وړیا حسابونه غوښتل کیږي چې یو پلان پیل کړي. تشریح باید دمخه ready وي (که نه نو 409).

د غوښتنې بدن

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

یوې نسخې ته بیرته راستنول

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

سر بیا مخکینۍ چمتو نسخې ته اشاره کوي او د هغې ګراف او ویډیو په ریکارډ کې منعکسوي. هدف باید د ویډیو سره یو ready نسخه وي (که نه نو 409).

د غوښتنې بدن

{ "versionId": "..." }

مستقیم حالت stream

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

د Server-Sent Events stream (text/event-stream). یو اتصال پرانیزئ او ستاسو په هر تشریح کې د حالت هر انتقال د event: status فریم په توګه راځي، نو تاسو کولی شئ د poll کولو پر ځای هغه شیبه چې worker پای ته رسیږي د "ویډیو چمتو" حالت تازه کړئ. stream ستاسو د کیلي مالک ته محدود دی.

غږونه

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 راستنوي.

د چلولو وخت config او روغتیا

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

عامه. { "authEnforced": true } راستنوي. د ژوندي والي کتنه په GET /health کې ده.