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 वर आहे.