API лавлагаа

endpoint бүр, түүний хүсэлт болон хариултын хэлбэртэй. Бүх зам https://sketchie.ai/api-д харьцангуй.

Гэрээ хэлэлцээр

endpoint /v1/* бүр 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-д байдаг.