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": "..." }

live स्थिती stream

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

एक Server-Sent Events stream (text/event-stream). एक जोडणी उगडात आनी तुमच्या खंयच्याय स्पश्टीकरणाचेर दर एक स्थिती संक्रमण एका event: status frame म्हूण येता, देखून तुमी poll करचे बदला worker सोंपतकच "व्हिडिओ तयार" स्थिती अपडेट करूं शकतात. stream तुमच्या कीच्या मालकाक मर्यादित आसा.

आवाज

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

निवेदन आवाज catalog. ऐच्छीक ?language=<code> त्या भाशेच्या मूळ आवाजांचेर filter करता. 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 लेगीत परत करता.

runtime config आनी भलायकी

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

सार्वजनीक. { "authEnforced": true } परत करता. एक liveness तपासणी GET /health चेर आसा.