ເອກະສານອ້າງອີງ API

ທຸກ endpoint, ພ້ອມຮູບແບບຄຳຮ້ອງຂໍ ແລະ ການຕອບກັບຂອງມັນ. ທຸກເສັ້ນທາງແມ່ນສຳພັນກັບ https://sketchie.ai/api.

ຂໍ້ຕົກລົງ

ທຸກ endpoint /v1/* ຕ້ອງການ header Authorization: Bearer sk_.... ຂໍ້ຜິດພາດກັບຄືນເປັນ JSON ດ້ວຍ flag error ແລະ message:

ການຕອບກັບຂໍ້ຜິດພາດ

{
  "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 ພ້ອມ record ທີ່ຢູ່ໃນຄິວ. poll ດຶງຄຳອະທິບາຍ ຈົນກ່ວາ ready.

body ຄຳຮ້ອງຂໍ

{
  "input": "Explain how DNS resolves a domain name",
  "length": "0:30",
  "aspect": "16:9",
  "voice": "sketchie:sulafat",
  "language": "en"
}

field	ຊະນິດ	ໝາຍເຫດ
`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	ທາງເລືອກ. code ພາສາທີ່ຮອງຮັບ (ຄ່າເລີ່ມຕົ້ນ `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 ຂ້າມການສ້າງ graph ແລະ render ມັນໂດຍກົງ, ແຕ່ endpoint ນີ້ຍັງສ້າງຄຳອະທິບາຍໃໝ່ ແລະ ໃຊ້ໂຄຕ້າຟຣີປົກກະຕິ ຫຼື ໂຄຕ້າແພັກເກັດເສຍເງິນຂອງຜູ້ເອີ້ນ. ເພື່ອແກ້ໄຂຄຳອະທິບາຍທີ່ມີຢູ່, ໃຊ້ ແກ້ໄຂຄຳອະທິບາຍ.

ຄືນ record ຄຳອະທິບາຍ: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null ຈົນພ້ອມ) ແລະ sceneGraph (null ຈົນຖືກສ້າງ). 400 ກັບຄືນສຳລັບ input ວ່າງທີ່ບໍ່ມີ source, length ຜິດຮູບແບບ, ຫຼື aspect, preset, fillMode ຫຼື language ທີ່ບໍ່ຖືກຕ້ອງ.

ດຶງຄຳອະທິບາຍ

GET https://sketchie.ai/api/v1/explainer/:id

ຄືນ record ເຕັມ: status ປັດຈຸບັນ, videoUrl ເມື່ອ ready, sceneGraph ທີ່ແກ້ໄຂໄດ້, ປະຫວັດເວີຊັນ (versions) ແລະ chunks ສາກຂອງເວີຊັນຫົວ. id ທີ່ຫາຍໄປຄືນ 404.

ລາຍການຄຳອະທິບາຍ

GET https://sketchie.ai/api/v1/explainer?limit=50

ລາຍການຄຳອະທິບາຍຂອງ key ທີ່ເອີ້ນ, ໃໝ່ສຸດກ່ອນ. ຈຳກັດຢູ່ເຈົ້າຂອງ key. limit ຖືກຈຳກັດຈາກ 1 ຫາ 100 (ຄ່າເລີ່ມຕົ້ນ 50). ຄືນສະຫຼຸບເບົາ (ບໍ່ມີ scene graph ຫຼື ເວີຊັນ). ສຳລັບ record ເຕັມ ໃຊ້ ດຶງຄຳອະທິບາຍ.

ແກ້ໄຂຄຳອະທິບາຍ

POST https://sketchie.ai/api/v1/explainer/:id/edit

ລິ່ມຂອງຄວາມສາມາດແກ້ໄຂ. ປ່ຽນຄຳສັ່ງພາສາທຳມະດາເປັນການ render ໃໝ່ແບບມີເປົ້າໝາຍ. ສະເພາະສາກທີ່ໄດ້ຮັບຜົນກະທົບເທົ່ານັ້ນທີ່ render ໃໝ່, ຜະລິດເວີຊັນໃໝ່. ຄືນ 202 ພ້ອມເວີຊັນໃນຄິວ. poll ດຶງຄຳອະທິບາຍ ຈົນກ່ວາເວີຊັນຫົວ ready. ນີ້ຕໍ່ທ້າຍວິດີໂອທີ່ມີຢູ່, ດັ່ງນັ້ນບໍ່ໃຊ້ຊ່ອງສ້າງວິດີໂອຟຣີອີກ. render ໃໝ່ຄັ້ງທຳອິດຂອງແຕ່ລະວິດີໂອຟຣີ. ຄັ້ງຕໍ່ໄປໃຊ້ນາທີແພັກເກັດເສຍເງິນ, ແລະ ບັນຊີຟຣີຖືກຮ້ອງຂໍໃຫ້ເລີ່ມແພັກເກັດ. ຄຳອະທິບາຍຕ້ອງເປັນ ready ແລ້ວ (ບໍ່ດັ່ງນັ້ນ 409).

body ຄຳຮ້ອງຂໍ

{ "instruction": "Make the title scene shorter and warmer" }

ຄືນຄ່າໄປເວີຊັນ

POST https://sketchie.ai/api/v1/explainer/:id/revert

ຊີ້ຫົວຄືນໄປເວີຊັນທີ່ພ້ອມກ່ອນໜ້າ ແລະ ສະທ້ອນ graph ແລະ ວິດີໂອຂອງມັນໃສ່ record. ເປົ້າໝາຍຕ້ອງເປັນເວີຊັນ ready ທີ່ມີວິດີໂອ (ບໍ່ດັ່ງນັ້ນ 409).

body ຄຳຮ້ອງຂໍ

{ "versionId": "..." }

stream ສະຖານະສົດ

GET https://sketchie.ai/api/v1/explainer/events

stream Server-Sent Events (text/event-stream). ເປີດການເຊື່ອມຕໍ່ໜຶ່ງ ແລະ ທຸກການປ່ຽນສະຖານະໃນຄຳອະທິບາຍໃດໆຂອງທ່ານມາເປັນ frame event: status, ດັ່ງນັ້ນທ່ານສາມາດອັບເດດສະຖານະ "ວິດີໂອພ້ອມ" ໃນຂະນະທີ່ worker ສຳເລັດແທນການ poll. stream ຖືກຈຳກັດຢູ່ເຈົ້າຂອງ key ຂອງທ່ານ.

ສຽງ

GET https://sketchie.ai/api/v1/voices

catalog ສຽງບັນຍາຍ. ?language=<code> ທາງເລືອກຕອງໄປສຽງເຈົ້າຂອງພາສານັ້ນ. ຄືນ voices (ແຕ່ລະສຽງມີ name ໃຊ້ງ່າຍ, id ເພື່ອສົ່ງເປັນ voice, 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 ສຳລັບບັນຊີທັງຟຣີ ແລະ ເສຍເງິນ. ບັນຊີຟຣີຄືນ plan: "free" ພ້ອມ videoAllowance, videosUsed ແລະ videosRemaining. ບັນຊີເສຍເງິນຍັງຄືນ planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining ແລະ bonusMinutes.

config ເວລາແລ່ນ ແລະ ສຸຂະພາບ

GET https://sketchie.ai/api/config

ສາທາລະນະ. ຄືນ { "authEnforced": true }. ການກວດການມີຊີວິດຢູ່ GET /health.