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 धरि क्लैंप होइत अछि (पूर्वनिर्धारित 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 सेहो घुराबैत अछि।

रनटाइम कन्फिग आ हेल्थ

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

सार्वजनिक। { "authEnforced": true } घुराबैत अछि। एकटा लाइवनेस जाँच GET /health पर अछि।