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. వర్కర్ గ్రాఫ్ జనరేషన్‌ను దాటవేసి దాన్ని నేరుగా 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 చేయడానికి బదులుగా వర్కర్ ముగించే క్షణంలో "వీడియో సిద్ధం" స్థితిని అప్‌డేట్ చేయవచ్చు. స్ట్రీమ్ మీ కీ యజమానికి పరిమితం.

వాయిస్‌లు

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 వద్ద ఉంది.