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 frame ஆக வருகிறது, எனவே 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-இல் உள்ளது.