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 ನಲ್ಲಿದೆ.