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 frame එකක් ලෙස පැමිණේ, එබැවින් 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 හි ඇත.