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

ലൈവ് സ്റ്റാറ്റസ് സ്ട്രീം

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

ഒരു Server-Sent Events സ്ട്രീം (text/event-stream). ഒരു കണക്ഷൻ തുറക്കുക, നിങ്ങളുടെ ഏതെങ്കിലും വിശദീകരണത്തിലെ ഓരോ സ്റ്റാറ്റസ് മാറ്റവും ഒരു event: status ഫ്രെയിമായി എത്തുന്നു, അതിനാൽ poll ചെയ്യുന്നതിന് പകരം worker പൂർത്തിയാക്കുന്ന നിമിഷം "വീഡിയോ തയ്യാർ" അവസ്ഥ അപ്ഡേറ്റ് ചെയ്യാം. സ്ട്രീം നിങ്ങളുടെ കീയുടെ ഉടമയ്ക്ക് പരിമിതം.

ശബ്ദങ്ങൾ

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-ൽ ഉണ്ട്.