የ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 ገደብ ይጋራሉ።

ማብራሪያ ይፍጠሩ

ማመንጨት ይጀምራል እና በወረፋ ካለ record ጋር 202 Accepted ይመልሳል። ready እስኪሆን ድረስ ማብራሪያ ያግኙ poll ያድርጉ።

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

የማብራሪያ record ይመልሳል: id፣ status፣ prompt፣ lengthSeconds፣ voice፣ language፣ aspect፣ videoUrl (እስኪዘጋጅ null) እና sceneGraph (እስኪመነጭ null)። source የሌለው ባዶ input፣ የተበላሸ length፣ ወይም ልክ ያልሆነ aspect፣ preset፣ fillMode ወይም language ሲኖር 400 ይመለሳል።

ማብራሪያ ያግኙ

ሙሉ record ይመልሳል: የአሁኑ status፣ ready ሲሆን videoUrl፣ ሊስተካከል የሚችል sceneGraph፣ የስሪት ታሪክ (versions) እና የራስ ስሪት ትዕይንት chunks። የጠፋ id 404 ይመልሳል።

ማብራሪያዎችን ዘርዝር

የሚጠራውን ቁልፍ ማብራሪያዎች፣ አዲሶቹ መጀመሪያ፣ ይዘረዝራል። ለቁልፉ ባለቤት የተገደበ። limit ከ 1 እስከ 100 ይጠበባል (ነባሪ 50)። ቀላል ማጠቃለያዎችን ይመልሳል (scene graph ወይም ስሪቶች የሉም)። ለሙሉ record ማብራሪያ ያግኙ ይጠቀሙ።

ማብራሪያ ያስተካክሉ

የማስተካከል ችሎታ ሽብልቅ። ቀላል-ቋንቋ መመሪያን ወደ ዒላማ ያለው እንደገና-render ይቀይሩ። የተጎዱ ትዕይንቶች ብቻ እንደገና render ይደረጋሉ፣ አዲስ ስሪት ያመነጫሉ። በወረፋ ካለ ስሪት ጋር 202 ይመልሳል። የራስ ስሪት ready እስኪሆን ድረስ ማብራሪያ ያግኙ poll ያድርጉ። ይህ ወደ ነባሩ ቪዲዮ ይታከላል፣ ስለዚህ ሌላ የነጻ-ቪዲዮ መፍጠሪያ ቦታ አይጠቀምም። የእያንዳንዱ ቪዲዮ የመጀመሪያ እንደገና-render ነጻ ነው። በኋላ ያሉት የተከፈለ-እቅድ ደቂቃዎችን ይጠቀማሉ፣ እና ነጻ መለያዎች እቅድ እንዲጀምሩ ይጠየቃሉ። ማብራሪያው አስቀድሞ ready መሆን አለበት (አለበለዚያ 409)።

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

ወደ ስሪት መልስ

ራስን ወደ ቀደመ ዝግጁ ስሪት እንደገና ይጠቁማል እና ግራፉን እና ቪዲዮውን በ record ላይ ያንጸባርቃል። ዒላማው ቪዲዮ ያለው ready ስሪት መሆን አለበት (አለበለዚያ 409)።

{ "versionId": "..." }

የቀጥታ ሁኔታ stream

የ Server-Sent Events stream (text/event-stream)። አንድ ግንኙነት ይክፈቱ እና በማንኛውም ማብራሪያዎ ላይ እያንዳንዱ የሁኔታ ሽግግር እንደ event: status frame ይደርሳል፣ ስለዚህ poll ከማድረግ ይልቅ worker በሚጨርስበት ቅጽበት "ቪዲዮ ዝግጁ" ሁኔታን ማዘመን ይችላሉ። stream ለቁልፍዎ ባለቤት የተገደበ ነው።

ድምጾች

የትረካ ድምጽ ካታሎግ። አማራጭ ?language=<code> ወደዚያ ቋንቋ ተወላጅ ድምጾች ያጣራል። voices ይመልሳል (እያንዳንዱ ቀላል name፣ እንደ voice ለማስተላለፍ id፣ language፣ isDefault እና ሊጫወት የሚችል preview_url) ጨምሮ ዓለም አቀፍ default። ድምጾች ይመልከቱ።

ቋንቋዎች

የሚደገፉ የትረካ ቋንቋዎች፣ እንደ { code, label, native }። እያንዳንዱ code በሚፈጠርበት ጊዜ ልክ የሆነ language ነው። ቋንቋዎች ይመልከቱ።

የመለያ ሁኔታ

videosGenerated (የዕድሜ ልክ)፣ የመለያ image እና isAdmin ይመልሳል። ማረጋገጫ ይፈልጋል።

የክፍያ ሁኔታ

ማረጋገጫ ይፈልጋል እና ለነጻ እና ለተከፈለ መለያዎች ሁለቱም 200 ይመልሳል። ነጻ መለያ videoAllowance፣ videosUsed እና videosRemaining ጋር plan: "free" ይመልሳል። የተከፈለ መለያ ደግሞ planLabel፣ billingInterval፣ trialStatus፣ quotaMinutes፣ minutesUsedThisPeriod፣ minutesRemaining እና bonusMinutes ይመልሳል።

የruntime config እና ጤና

ይፋዊ። { "authEnforced": true } ይመልሳል። የሕይወት ማረጋገጫ በ GET /health ላይ ነው።