ឯកសារយោង API

អនុសញ្ញា

រាល់ endpoint /v1/* ត្រូវការក្បាល Authorization: Bearer sk_...។ កំហុសត្រឡប់ជា JSON ជាមួយទង់ error និង message៖

{
  "error": true,
  "message": "length must be a positive multiple of 30 seconds, at most 360"
}

endpoint បង្កើតត្រូវបានកំណត់ត្រឹម 20 សំណើក្នុងមួយនាទី។ endpoint ផ្សេងទៀតទាំងអស់ចែករំលែកដែនកំណត់ 200 ក្នុងមួយនាទី។

បង្កើតការពន្យល់

ចាប់ផ្តើមការបង្កើត និងត្រឡប់ 202 Accepted ជាមួយកំណត់ត្រាក្នុងជួរ។ poll ទាញយកការពន្យល់ រហូតដល់ ready។

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

ត្រឡប់កំណត់ត្រាការពន្យល់៖ id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (null រហូតដល់រួចរាល់) និង sceneGraph (null រហូតដល់បង្កើត)។ 400 ត្រឡប់សម្រាប់ input ទទេគ្មាន source, length មិនត្រឹមត្រូវ ឬ aspect, preset, fillMode ឬ language មិនត្រឹមត្រូវ។

ទាញយកការពន្យល់

ត្រឡប់កំណត់ត្រាពេញ៖ status បច្ចុប្បន្ន videoUrl ពេល ready, sceneGraph ដែលអាចកែសម្រួលបាន ប្រវត្តិកំណែ (versions) និង chunks ឆាកនៃកំណែក្បាល។ id ដែលបាត់ត្រឡប់ 404។

រាយការពន្យល់

រាយការពន្យល់នៃកូនសោហៅ ថ្មីបំផុតមុន។ កំណត់ត្រឹមម្ចាស់កូនសោ។ limit ត្រូវបានកំណត់ពី 1 ដល់ 100 (លំនាំដើម 50)។ ត្រឡប់សេចក្តីសង្ខេបស្រាល (គ្មាន scene graph ឬកំណែ)។ សម្រាប់កំណត់ត្រាពេញ ប្រើ ទាញយកការពន្យល់។

កែសម្រួលការពន្យល់

ស្នៀតនៃលទ្ធភាពកែសម្រួល។ បំប្លែងការណែនាំជាភាសាធម្មតាទៅជាការ render ឡើងវិញដែលមានគោលដៅ។ មានតែឆាកដែលរងផលប៉ះពាល់ប៉ុណ្ណោះដែល render ឡើងវិញ បង្កើតកំណែថ្មី។ ត្រឡប់ 202 ជាមួយកំណែក្នុងជួរ។ poll ទាញយកការពន្យល់ រហូតដល់កំណែក្បាល ready។ វាបន្ថែមទៅវីដេអូដែលមានស្រាប់ ដូច្នេះមិនប្រើកន្លែងបង្កើតវីដេអូឥតគិតថ្លៃមួយទៀតទេ។ ការ render ឡើងវិញលើកដំបូងនៃវីដេអូនីមួយៗឥតគិតថ្លៃ។ ក្រោយៗប្រើនាទីគម្រោងបង់ប្រាក់ ហើយគណនីឥតគិតថ្លៃត្រូវបានស្នើឱ្យចាប់ផ្តើមគម្រោង។ ការពន្យល់ត្រូវតែ ready រួចហើយ (បើមិនដូច្នេះ 409)។

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

ត្រឡប់ទៅកំណែ

ចង្អុលក្បាលឡើងវិញទៅកំណែរួចរាល់មុន ហើយឆ្លុះក្រាហ្វ និងវីដេអូរបស់វាទៅលើកំណត់ត្រា។ គោលដៅត្រូវតែជាកំណែ ready ដែលមានវីដេអូ (បើមិនដូច្នេះ 409)។

{ "versionId": "..." }

ស្ទ្រីមស្ថានភាពផ្ទាល់

ស្ទ្រីម Server-Sent Events (text/event-stream)។ បើកការតភ្ជាប់មួយ ហើយរាល់ការផ្លាស់ប្តូរស្ថានភាពលើការពន្យល់ណាមួយរបស់អ្នកមកដល់ជា frame event: status ដូច្នេះអ្នកអាចធ្វើបច្ចុប្បន្នភាពស្ថានភាព "វីដេអូរួចរាល់" នៅពេល worker បញ្ចប់ជំនួសឱ្យ poll។ ស្ទ្រីមត្រូវបានកំណត់ត្រឹមម្ចាស់កូនសោរបស់អ្នក។

សំឡេង

កាតាឡុកសំឡេងនិទាន។ ?language=<code> ជាជម្រើសត្រងទៅសំឡេងដើមកំណើតនៃភាសានោះ។ ត្រឡប់ voices (នីមួយៗមាន name ងាយស្រួល id ដើម្បីបញ្ជូនជា voice, language, isDefault និង preview_url ដែលអាចចាក់បាន) បូក default សកល។ មើល សំឡេង។

ភាសា

ភាសានិទានដែលបានគាំទ្រ ជា { code, label, native }។ រាល់ code គឺជា language ត្រឹមត្រូវពេលបង្កើត។ មើល ភាសា។

ស្ថានភាពគណនី

ត្រឡប់ videosGenerated (ពេញមួយជីវិត), image គណនី និង isAdmin។ ត្រូវការការផ្ទៀងផ្ទាត់។

ស្ថានភាពវិក្កយបត្រ

ត្រូវការការផ្ទៀងផ្ទាត់ ហើយត្រឡប់ 200 សម្រាប់គណនីទាំងឥតគិតថ្លៃ និងបង់ប្រាក់។ គណនីឥតគិតថ្លៃត្រឡប់ plan: "free" ជាមួយ videoAllowance, videosUsed និង videosRemaining។ គណនីបង់ប្រាក់ក៏ត្រឡប់ planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining និង bonusMinutes។

ការកំណត់ពេលដំណើរការ និងសុខភាព

សាធារណៈ។ ត្រឡប់ { "authEnforced": true }។ ការត្រួតពិនិត្យភាពរស់រានមានៅ GET /health។