AnimGen
註冊
跳至本文
使用文件

搜尋文件

搜尋僅在此瀏覽器進行，關鍵字不會傳送或儲存。請勿輸入憑證。

正在載入搜尋索引…

Tab 或方向鍵移動 · Enter 開啟 · Esc 關閉
English简体中文日本語
瀏覽文件

共享欄位與資料結構

從後端原始碼生成共享欄位、巢狀型別、預設值、必填項與約束，避免在文件中維護第二份引數定義。

公開測試最後核實
本頁目錄

“—”表示沒有宣告預設值，不等於 null。欄位在 JSON Schema 中可選，仍可能受工作流的條件必填限制。模型專屬選項仍需查詢即時能力。

AnimationCreateRequest

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
export ExportOptions 否 {"fps":null,"frame_count":24,"output_formats":["spritesheet"],"output_height":512,"output_width":512,"transparent":{"enabled":false},"unity":{"pivot":"bottom_center","pixels_per_unit":100}} — 影片生成後執行匯出；帶 Alpha 的格式要求 alpha_key 來源，適配格式會自動啟用其透明處理。
input GenerationInput 是 — — 呼叫方所屬或本次提供的生成圖片。
metadata object 否 {} — 呼叫方後設資料，僅字串、數字、布林或 null；JSON 不超過 4 KiB，不存憑據。
negative_prompt string 否 "" maxLength: 4000 可選負向提示詞，僅適用於支援的模型。
prompt string 否 "" maxLength: 8000 動作提示詞；模型要求時不能為空，私有提示詞不得寫入日誌。
selection Selection 否 {"duration_seconds":null,"mode":"full","start_seconds":0} — 生成後選取的區間，預設完整影片。
video VideoOptions 否 {"duration_seconds":null,"input_canvas":null,"model":null,"ratio":null,"resolution":null,"seed":null,"style_preset":null,"transparency":{"key_color":null,"key_selection":"auto","mode":"standard"},"watermark":null} — 符合模型能力的生成設定。

AnimationExportCreateRequest

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
export ExportOptions 否 {"fps":null,"frame_count":24,"output_formats":["spritesheet"],"output_height":512,"output_width":512,"transparent":{"enabled":false},"unity":{"pivot":"bottom_center","pixels_per_unit":100}} — 輸出格式及處理設定。
metadata object 否 {} — 簡單標量或 null 後設資料，JSON 不超過 4 KiB，不包含憑據。
selection Selection 否 {"duration_seconds":null,"mode":"full","start_seconds":0} — 需要匯出的源影片區間。
source_video_asset_id string 是 — format: uuid 所屬源影片資產 ID，不是任務 ID；複用已有影片可避免重新生成動作。

AssetResponse

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
byte_size integer 是 — — 檔案預期位元組數。
created_at string 是 — format: date-time UTC 建立時間。
download_expires_at string 是 — format: date-time 簽名 URL 的 UTC 過期時間；過期後重新查詢資產。
download_url string 是 — — 敏感短期簽名 URL；下載及跳轉時均不攜帶 Bearer 頭，不記錄此 URL。
format string 是 — — 實際資產格式，不要依賴 outputs 固定順序。
id string 是 — format: uuid 穩定公共資產 ID，用於重新整理下載資訊。
media MediaResponse / null 否 null — 白名單內的實測影片資訊，未知欄位為 null；非影片資產為 null。
mime_type string 是 — — 資產媒體型別。
object string 否 "asset" const: "asset" —

Base64ImageInput

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
data string 是 — minLength: 4 純 Base64，不含 data URL 字首；解碼後單張 10 MiB、合計 20 MiB。
media_type string 是 — enum: "image/png", "image/jpeg", "image/webp" 圖片實際 MIME 型別。
type string 是 — const: "base64" —

CreditUsage

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
charged integer 是 — — 最終淨扣費點數。供應商明確稽核拒絕會退分，取消本身不代表退款。
held integer 是 — — 當前預佔點數，不應與 charged 相加當作扣費。
quoted integer 是 — — 報價總額，不一定等於最終扣費。
refunded integer 否 0 — 扣費後退回的點數，已從 charged 中扣除，不是現金退款。
released integer 否 0 — 尚未確認扣費即釋放的點數。
status string / null 否 null — 點數狀態：held、charged、released、refunded，內部子任務可為 managed。

ExportOptions

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
fps number / null 否 null maximum: 60; exclusiveMinimum: 0 按源影片原速取樣，不補幀；僅用於獨立匯出，需 spritesheet 和 spritesheet_json；短尾幀保留選區總時長。
frame_count integer / null 否 null minimum: 1; maximum: 240 舊版等間隔幀數，與 fps 互斥；兩者均省略時使用 24 幀。
output_formats array<string> 否 ["spritesheet"] minItems: 1; 元素：enum: "clip_video", "webm_alpha", "prores_4444", "frames_zip", "spritesheet", "spritesheet_json", "unity_meta", "unity_pack", "godot_pack", "unreal_paper2d_pack", "cocos_creator_pack" 請求的資產格式；幀數模式預設 spritesheet，FPS 模式預設 spritesheet 加 spritesheet_json。重複項會去重，後設資料需配套紋理。
output_height integer 否 512 minimum: 64; maximum: 1024 輸出幀高度，單位畫素。
output_width integer 否 512 minimum: 64; maximum: 1024 輸出幀寬度，單位畫素。
transparent ExportTransparency 否 {"enabled":false} — 使用 enabled 物件形式；相容布林值輸入並規範化為此物件。
unity UnityOptions 否 {"pivot":"bottom_center","pixels_per_unit":100} — Unity 專用後設資料和資源包設定。

ExportTransparency

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
enabled boolean 否 false — 為相容輸出啟用透明處理；要求 alpha_key 來源，不會讓 MP4 透明。

ExportWarning

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
code string 是 — — —
details object 否 {} — —
message string 是 — — —

FileImageInput

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
file_id string 是 — format: uuid POST /files 或 complete_image_upload 返回的所屬公共檔案 ID，不是 Studio uploadId。
type string 是 — const: "file" —

GenerationInput

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
first_frame FileImageInput / Base64ImageInput / UrlImageInput 是 — discriminator: type 必需首幀，用 type 選擇圖片傳入方式。
last_frame FileImageInput / Base64ImageInput / UrlImageInput / null 否 null discriminator: type 可選尾幀，所選模型必須支援首尾幀模式。
reference_images array<FileImageInput / Base64ImageInput / UrlImageInput> 否 [] maxItems: 8; 元素：discriminator: type 額外參考圖，不含首幀；即時模型可能有更低上限。

GenerationTransparency

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
key_color string / null 否 null — 手動選擇時使用的臨時鍵色；通常保留自動選擇。
key_selection string 否 "auto" enum: "auto", "manual" 臨時鍵色的選擇方式。
mode string 否 "standard" enum: "standard", "alpha_key" standard 保留場景；alpha_key 要求所有參與圖片有有效 Alpha，原始影片仍不透明。

InputCanvasOptions

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
aspect_ratio string 否 "follow_output" enum: "follow_output", "source" 跟隨輸出比例或保持原圖比例。
background string 否 "auto" enum: "auto", "transparent", "solid" 畫布擴充套件區域的背景策略。
background_color string / null 否 null pattern: ^#[0-9A-Fa-f]{6}$ 純色擴充套件區域的六位 RGB 顏色。
enabled boolean 否 true — 是否準備擴充套件輸入畫布。
position_x number 否 0.5 minimum: 0; maximum: 1 歸一化水平位置。
position_y number 否 0.5 minimum: 0; maximum: 1 歸一化垂直位置。
source_scale number 否 0.8 minimum: 0.5; maximum: 1 原圖主體在畫布中的縮放比例。

McpQuoteOutput

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
breakdown object 是 — — 公開費用組成。
credits integer 是 — — 報價點數，生成前需向用戶展示。
expires_at string 是 — format: date-time 報價過期時間；過期或變價時重新報價並確認。
quote_id string 是 — format: uuid 屬於當前使用者和 OAuth 客戶端的短期報價，可繫結一次邏輯生成鍵。
resolved_export ResolvedExport / null 否 null — 獨立 FPS 匯出的確定取樣摘要。

McpUploadCompleteOutput

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
byte_size integer 是 — — 校驗後的圖片位元組數。
file_id string 是 — format: uuid 用於 request.input.first_frame 的可複用所屬公共檔案 ID。
mime_type string 是 — — 校驗後的圖片 MIME 型別。
sha256 string 是 — — 上傳圖片位元組的 SHA-256。

McpUploadPrepareOutput

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
expires_at string 是 — format: date-time 上傳 URL 過期時間。
headers object 是 — — 實際傳輸請求頭，不額外新增 MCP Token 或 API Bearer 憑據。
max_bytes integer 是 — — 允許上傳的最大位元組數。
method string 否 "PUT" const: "PUT" 客戶端傳輸位元組時必須使用的 HTTP 方法。
upload_id string 是 — format: uuid 傳給 complete_image_upload 的上傳會話 ID，不是最終 file_id。
upload_url string 是 — — 敏感短期上傳 URL，需傳輸實際位元組，不公開此地址。

MediaResponse

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
duration_seconds number / null 否 null — 根據呈現時間戳測得的可播放影片時長，不使用供應商請求時長。
fps number / null 否 null — 實測源平均幀率；可變幀率選幀仍依據呈現時間戳。
frame_count integer / null 否 null — 解碼源幀數，未知為 null。
height integer / null 否 null — 考慮旋轉後的顯示高度，單位畫素。
width integer / null 否 null — 考慮旋轉後的顯示寬度，單位畫素。

ModelCapabilities

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
aspect_ratio_mode string 是 — — 供應商對畫幅比例的處理模式。
default_duration_seconds integer 是 — — 預設生成時長，秒。
default_ratio string / null 是 — — 預設比例，不適用時為 null。
default_resolution string / null 是 — — 預設解析度，不適用時為 null。
durations array<integer> 是 — — 支援的生成秒數，同時檢查解析度專屬限制。
durations_by_resolution object 否 {} — 各解析度支援的時長秒數。
id string 是 — — 請求使用的 provider:model 標識，以即時目錄為準。
label string 是 — — 人類可讀模型名稱。
max_reference_images integer 是 — — 模型參考圖容量；參考圖模式中首幀佔第一個參考圖槽位。
model string 是 — — 供應商內的模型標識。
modes array<string> 是 — — 支援的輸入模式，如 first_frame、first_last_frame、reference_images。
provider string 是 — — 公開供應商標識。
ratios array<string> 是 — — 支援的比例；存在 ratios_by_mode 時同時檢查。
ratios_by_mode object 否 {} — 各輸入模式支援的比例。
reference_image_duration_seconds integer / null 是 — — 參考圖模式有固定限制時要求的秒數。
requires_prompt boolean 是 — — 是否要求提示詞非空。
resolutions array<string> 是 — — 支援的解析度選項。
returns_last_frame boolean 是 — — 模型是否可返回末幀資產。
supports_first_frame boolean 是 — — 是否支援首幀輸入。
supports_last_frame boolean 是 — — 是否支援尾幀輸入。
supports_negative_prompt boolean 是 — — 是否支援負向提示詞。
supports_reference_images boolean 是 — — 是否支援參考圖模式。
supports_seed boolean 是 — — 是否支援 seed。
supports_watermark boolean 是 — — 是否支援水印設定。

ModelsResponse

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
data array<ModelCapabilities> 是 — — 當前啟用的模型，客戶端不要寫死此清單。
object string 否 "list" const: "list" —

PreviewCell

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
index integer 是 — minimum: 0 原始時間點請求中的位置，從 0 開始。
rect PreviewRect 是 — — 聯絡表中的影像區域，不包含時間標籤。
requested_time_seconds number 是 — — 相對源影片可播放起點的請求時間。
source_time_seconds number 是 — — 請求時間正在顯示的源幀的呈現時間。

PreviewRect

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
height integer 是 — exclusiveMinimum: 0 縮圖高度，不含留白及標籤。
width integer 是 — exclusiveMinimum: 0 縮圖寬度，不含留白及標籤。
x integer 是 — minimum: 0 相對聯絡表左上角的橫向畫素座標。
y integer 是 — minimum: 0 相對聯絡表左上角的縱向畫素座標。

ResolvedExport

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
duration_ms integer 是 — — Manifest 逐幀時長的毫秒總和。
fps number 是 — — 目標取樣頻率，不按幀數除以時長重新計算。
frame_count integer 是 — — 嚴格位於選區終點前的取樣幀數。
selection Selection 是 — — 實際源區間，full 使用實測可播放時長。
warnings array<ExportWarning> 否 [] — 取樣警告，包含未補幀而重複採到源幀的情況。

Selection

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
duration_seconds number / null 否 null exclusiveMinimum: 0 mode=range 時必填，選段時長秒數必須為正。
mode string 否 "full" enum: "full", "range" full 使用完整來源；range 必須提供 duration_seconds。
start_seconds number 否 0 minimum: 0 相對源影片起點的選段開始秒數。

TaskError

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
code string 是 — — 供程式識別的任務錯誤碼。
details object 否 {} — 公開錯誤詳情，不含私有儲存或供應商值。
message string 是 — — 人類可讀說明，不應作為穩定分支條件。
param string / null 否 null — 可用時提供相關公開引數。
retryable boolean 否 false — 重試是否可能有幫助；新建付費任務前先檢查部分產物。

TaskResponse

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
created_at string 是 — format: date-time 任務被接受的 UTC 時間。
credits CreditUsage 是 — — 報價、預佔及已扣點數狀態。
error TaskError / null 否 null — 任務失敗資訊，與是否存在可用產物分別判斷。
finished_at string / null 否 null format: date-time 已知時返回 UTC 終態時間。
id string 是 — format: uuid 建立後立即儲存任務 ID，通過它輪詢，不要再次建立。
metadata object 否 {} — 呼叫方提供的後設資料。
normalized_input object 否 {} — 規範化公共輸入，可能含私有提示詞或圖片引用，不要整體寫入日誌。
object string 是 — enum: "video_generation", "animation_export", "animation" 公共任務資源型別。
outputs array<AssetResponse> 否 [] — 可用資產，失敗或取消也可能有部分產物；所有終態都應檢查。
progress number 是 — minimum: 0; maximum: 1 0 至 1 的進度值，不代表精確完成時間。
resolved_export ResolvedExport / null 否 null — 持久化的 FPS 取樣摘要，與報價、Manifest 一致；歷史任務為 null。
stage string / null 否 null enum: "queued", "video_generation", "animation_export", "completed" 可用時顯示當前流水線階段。
started_at string / null 否 null format: date-time 已知時返回 UTC 生產開始時間。
status string 是 — enum: "queued", "running", "cancelling", "succeeded", "failed", "cancelled" succeeded、failed、cancelled 為終態；cancelling 不是終態。

UnityOptions

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
pivot string 否 "bottom_center" const: "bottom_center" 支援的 Unity 精靈錨點。
pixels_per_unit integer 否 100 minimum: 1; maximum: 1000 Unity 每世界單位對應的紋理畫素數。

UrlImageInput

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
type string 是 — const: "url" —
url string 是 — minLength: 9; maxLength: 2048 公開 HTTPS 圖片，443 埠，不帶憑據或 fragment；禁止私網和不安全跳轉，重試期間保持圖片位元組穩定。

VideoGenerationCreateRequest

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
input GenerationInput 是 — — 呼叫方所屬或本次提供的生成圖片。
metadata object 否 {} — 呼叫方後設資料，僅字串、數字、布林或 null；JSON 不超過 4 KiB，不存憑據。
negative_prompt string 否 "" maxLength: 4000 可選負向提示詞，僅適用於支援的模型。
prompt string 否 "" maxLength: 8000 動作提示詞；模型要求時不能為空，私有提示詞不得寫入日誌。
video VideoOptions 否 {"duration_seconds":null,"input_canvas":null,"model":null,"ratio":null,"resolution":null,"seed":null,"style_preset":null,"transparency":{"key_color":null,"key_selection":"auto","mode":"standard"},"watermark":null} — 符合模型能力的生成設定。

VideoGenerationQuoteRequest

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
has_last_frame boolean 否 false — 計劃請求是否包含尾幀。
reference_image_count integer 否 0 minimum: 0; maximum: 8 額外參考圖數量，不含首幀。
video VideoOptions 否 {"duration_seconds":null,"input_canvas":null,"model":null,"ratio":null,"resolution":null,"seed":null,"style_preset":null,"transparency":{"key_color":null,"key_selection":"auto","mode":"standard"},"watermark":null} — 擬報價的生成選項，應與後續建立一致。

VideoOptions

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
duration_seconds number / null 否 null exclusiveMinimum: 0 秒數，需符合模型與解析度支援範圍；省略時使用模型預設值。
input_canvas InputCanvasOptions / null 否 null — 可選輸入畫布設定；省略時保持來源構圖。
model string / null 否 null — GET /models 返回的 provider:model ID；省略時使用配置的預設模型。
ratio string / null 否 null — 當前模型與輸入模式支援的畫幅比例。
resolution string / null 否 null — 即時模型目錄中的解析度值。
seed integer / null 否 null minimum: 0; maximum: 2147483647 僅適用於宣告支援 seed 的模型，不保證所有輸出確定性。
style_preset string / null 否 null — 所選供應商或模型支援的可選風格預設。
transparency GenerationTransparency 否 {"key_color":null,"key_selection":"auto","mode":"standard"} — 來源透明流程；透明匯出要求 alpha_key。
watermark boolean / null 否 null — 可選水印設定，需檢查模型能力。

VideoPreviewRequest

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
max_frame_size integer 否 256 minimum: 32; maximum: 512 縮圖最長邊畫素數，保持寬高比。
timestamps_seconds array<number> 是 — minItems: 1; maxItems: 12; 元素：minimum: 0 按請求順序提供源時間點，每個點嚴格小於可播放終點，最多 12 個。

VideoPreviewResponse

禁止未宣告的欄位。

欄位 型別 必填 預設值 約束 含義
cells array<PreviewCell> 是 — — 按請求順序排列的縮圖，保留重複時間點。
height integer 是 — — 聯絡表高度，包含標籤及留白，單位畫素。
image AssetResponse 是 — — 快取的 PNG 聯絡表，提供可重新整理的簽名下載地址。
object string 否 "video_preview" const: "video_preview" —
source_video_asset_id string 是 — format: uuid 穩定的源影片資產 ID。
width integer 是 — — 聯絡表寬度，包含標籤及留白，單位畫素。

這篇文件有幫助嗎？

不收集搜尋字詞、程式碼或自由文字。此開關僅控制文件互動事件。 隱私權政策

需要協助？聯絡支援