본문으로 건너뛰기
사용 문서

문서 검색

검색은 브라우저 안에서만 이루어지며 검색어를 전송하거나 저장하지 않습니다. 인증 정보를 입력하지 마세요.

검색 색인을 불러오는 중…

Tab 또는 방향키로 이동 · Enter로 열기 · Esc로 닫기
문서 탐색

공유 스키마 정의

원본 계약에서 생성한 필드 정의, 중첩 유형, 기본값, 필수 지정 및 제약입니다.

공개 베타최종 확인
이 페이지의 내용

대시(—)는 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}} — Export after video generation. Alpha-bearing formats require an alpha_key source; compatible formats automatically enable its transparent export.
input GenerationInput 예 — — Images owned by the caller or supplied for this generation.
metadata object 아니요 {} — Caller metadata: simple string/number/boolean/null values, at most 4 KiB JSON. Do not store secrets.
negative_prompt string 아니요 "" maxLength: 4000 Optional exclusions, only when the model supports negative prompts.
prompt string 아니요 "" maxLength: 8000 Motion instruction; nonempty when the model requires a prompt. Keep private prompts out of logs.
selection Selection 아니요 {"duration_seconds":null,"mode":"full","start_seconds":0} — Interval selected after generation; full by default.
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} — Model-compatible generation settings.

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}} — Output formats and processing settings.
metadata object 아니요 {} — Simple scalar/null metadata; at most 4 KiB JSON, no credentials.
selection Selection 아니요 {"duration_seconds":null,"mode":"full","start_seconds":0} — Source interval to export.
source_video_asset_id string 예 — format: uuid Owned source video asset ID, not a task ID. Reuse an existing video to avoid generating motion again.

AssetResponse

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
byte_size integer 예 — — Expected file size in bytes.
created_at string 예 — format: date-time Creation timestamp in UTC.
download_expires_at string 예 — format: date-time Signed URL expiry in UTC; refresh via asset lookup when expired.
download_url string 예 — — Sensitive short-lived signed URL. Download without a Bearer header, including after redirects; never log the URL.
format string 예 — — Artifact format; inspect actual outputs rather than assuming an array order.
id string 예 — format: uuid Stable public asset ID; use it to refresh download metadata.
media MediaResponse / null 아니요 null — Whitelisted measured video metadata. Unknown fields are null; non-video assets return null.
mime_type string 예 — — Asset media type.
object string 아니요 "asset" const: "asset" —

Base64ImageInput

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
data string 예 — minLength: 4 Pure Base64 without a data URL prefix; decoded limits: 10 MiB per image, 20 MiB total.
media_type string 예 — enum: "image/png", "image/jpeg", "image/webp" Actual image MIME type.
type string 예 — const: "base64" —

CreditUsage

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
charged integer 예 — — Net charged credits. Confirmed provider moderation rejection is refunded; cancellation alone is not a refund.
held integer 예 — — Credits currently reserved, not an additional charge to sum with charged.
quoted integer 예 — — Quoted total, not necessarily the final charge.
refunded integer 아니요 0 — Credits returned after a charge; already excluded from charged. Not a cash refund.
released integer 아니요 0 — Credits returned from an uncommitted hold.
status string / null 아니요 null — Billing state: held, charged, released, refunded, or managed for internal child tasks.

ExportOptions

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
fps number / null 아니요 null maximum: 60; exclusiveMinimum: 0 Source-speed sampling frequency, without interpolation. Independent exports only; requires spritesheet and spritesheet_json. A short final frame preserves the selection duration.
frame_count integer / null 아니요 null minimum: 1; maximum: 240 Legacy uniform frame count, mutually exclusive with fps. When both are omitted, uses 24 frames.
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" Requested asset formats; defaults to spritesheet in frame_count mode, or spritesheet plus spritesheet_json in FPS mode. Duplicates are removed. Metadata needs its matching texture.
output_height integer 아니요 512 minimum: 64; maximum: 1024 Output frame height in pixels.
output_width integer 아니요 512 minimum: 64; maximum: 1024 Output frame width in pixels.
transparent ExportTransparency 아니요 {"enabled":false} — Use the enabled object form. Legacy booleans are accepted but normalized to this object.
unity UnityOptions 아니요 {"pivot":"bottom_center","pixels_per_unit":100} — Settings for Unity-specific metadata and packs.

ExportTransparency

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
enabled boolean 아니요 false — Transparent processing for compatible outputs; requires an alpha_key source and does not make MP4 transparent.

ExportWarning

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
code string 예 — — —
details object 아니요 {} — —
message string 예 — — —

FileImageInput

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
file_id string 예 — format: uuid Owned public file ID from POST /files or complete_image_upload; not a Studio upload ID.
type string 예 — const: "file" —

GenerationInput

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
first_frame FileImageInput / Base64ImageInput / UrlImageInput 예 — discriminator: type Required starting image; use the type discriminator to select an input representation.
last_frame FileImageInput / Base64ImageInput / UrlImageInput / null 아니요 null discriminator: type Optional end image; the selected model must support first/last-frame mode.
reference_images array<FileImageInput / Base64ImageInput / UrlImageInput> 아니요 [] maxItems: 8; 항목: discriminator: type Additional references, excluding the first frame. The live model can impose a smaller limit.

GenerationTransparency

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
key_color string / null 아니요 null — Temporary key color when using manual selection; normally leave automatic selection enabled.
key_selection string 아니요 "auto" enum: "auto", "manual" How the temporary key color is selected.
mode string 아니요 "standard" enum: "standard", "alpha_key" standard keeps the scene; alpha_key requires meaningful alpha in all active input images. Raw videos remain opaque.

InputCanvasOptions

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
aspect_ratio string 아니요 "follow_output" enum: "follow_output", "source" Follow the output ratio or preserve the source ratio.
background string 아니요 "auto" enum: "auto", "transparent", "solid" Canvas extension background strategy.
background_color string / null 아니요 null pattern: ^#[0-9A-Fa-f]{6}$ Six-digit RGB color for a solid extension.
enabled boolean 아니요 true — Whether to prepare an expanded input canvas.
position_x number 아니요 0.5 minimum: 0; maximum: 1 Normalized horizontal source position.
position_y number 아니요 0.5 minimum: 0; maximum: 1 Normalized vertical source position.
source_scale number 아니요 0.8 minimum: 0.5; maximum: 1 Source subject scale within the canvas.

McpQuoteOutput

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
breakdown object 예 — — Public cost components.
credits integer 예 — — Quoted credits; show the amount to the user before generation.
expires_at string 예 — format: date-time Quote expiry; re-quote and confirm if it expires or price changes.
quote_id string 예 — format: uuid Short-lived quote owned by this user and OAuth client; can bind to one logical generation key.
resolved_export ResolvedExport / null 아니요 null — Resolved sampling summary for an independent FPS export.

McpUploadCompleteOutput

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
byte_size integer 예 — — Validated image byte count.
file_id string 예 — format: uuid Reusable owned public file ID for request.input.first_frame.
mime_type string 예 — — Validated image MIME type.
sha256 string 예 — — SHA-256 of the uploaded image bytes.

McpUploadPrepareOutput

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
expires_at string 예 — format: date-time Upload URL expiry.
headers object 예 — — Exact transfer headers; do not add MCP tokens or API Bearer credentials.
max_bytes integer 예 — — Maximum accepted upload byte count.
method string 아니요 "PUT" const: "PUT" HTTP method the client must use for the byte transfer.
upload_id string 예 — format: uuid Upload session ID for complete_image_upload, not the final file_id.
upload_url string 예 — — Sensitive short-lived upload URL. Transfer actual bytes; do not publish this URL.

MediaResponse

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
duration_seconds number / null 아니요 null — Playable video duration measured from presentation timestamps; never provider-requested duration.
fps number / null 아니요 null — Measured average source frame rate; use presentation timestamps for VFR selection.
frame_count integer / null 아니요 null — Decoded source frame count, or null when unknown.
height integer / null 아니요 null — Displayed video height in pixels, accounting for rotation.
width integer / null 아니요 null — Displayed video width in pixels, accounting for rotation.

ModelCapabilities

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
aspect_ratio_mode string 예 — — Provider's aspect-ratio handling mode.
default_duration_seconds integer 예 — — Default generation duration in seconds.
default_ratio string / null 예 — — Default ratio, or null when not applicable.
default_resolution string / null 예 — — Default resolution, or null when not applicable.
durations array<integer> 예 — — Supported generation durations in seconds; also inspect resolution-specific constraints.
durations_by_resolution object 아니요 {} — Resolution-specific supported durations in seconds.
id string 예 — — Stable provider:model selector for requests; use the live catalog.
label string 예 — — Human-readable model label.
max_reference_images integer 예 — — Model reference-image capacity; the first frame occupies the first reference slot in reference mode.
model string 예 — — Model identifier within the provider.
modes array<string> 예 — — Supported input modes, such as first_frame, first_last_frame, or reference_images.
provider string 예 — — Public provider identifier.
ratios array<string> 예 — — Supported aspect ratio values; check ratios_by_mode where present.
ratios_by_mode object 아니요 {} — Input-mode-specific supported ratios.
reference_image_duration_seconds integer / null 예 — — Required duration for reference mode, when constrained.
requires_prompt boolean 예 — — Whether prompt must be nonempty.
resolutions array<string> 예 — — Supported resolution values.
returns_last_frame boolean 예 — — Whether the model can return a last-frame asset.
supports_first_frame boolean 예 — — Whether a first-frame input is supported.
supports_last_frame boolean 예 — — Whether a last-frame input is supported.
supports_negative_prompt boolean 예 — — Whether negative_prompt is supported.
supports_reference_images boolean 예 — — Whether reference-image mode is supported.
supports_seed boolean 예 — — Whether seed is supported.
supports_watermark boolean 예 — — Whether the watermark setting is supported.

ModelsResponse

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
data array<ModelCapabilities> 예 — — Currently enabled models; do not hard-code this list in a client.
object string 아니요 "list" const: "list" —

PreviewCell

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
index integer 예 — minimum: 0 Zero-based position in the original timestamp request.
rect PreviewRect 예 — — Image area within the contact sheet; excludes the timestamp label.
requested_time_seconds number 예 — — Requested time relative to the playable source origin.
source_time_seconds number 예 — — Presentation time of the source frame displayed at the requested time.

PreviewRect

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
height integer 예 — exclusiveMinimum: 0 Thumbnail height, excluding padding and label.
width integer 예 — exclusiveMinimum: 0 Thumbnail width, excluding padding and label.
x integer 예 — minimum: 0 Left pixel from the sheet origin.
y integer 예 — minimum: 0 Top pixel from the sheet origin.

ResolvedExport

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
duration_ms integer 예 — — Sum of manifest frame durations in milliseconds.
fps number 예 — — Target sampling frequency; never recalculated as frame_count / duration.
frame_count integer 예 — — Number of samples strictly before the selected end.
selection Selection 예 — — Resolved source interval; full uses measured playable duration.
warnings array<ExportWarning> 아니요 [] — Sampling warnings, including repeated source frames without interpolation.

Selection

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
duration_seconds number / null 아니요 null exclusiveMinimum: 0 Required when mode=range; positive interval length in seconds.
mode string 아니요 "full" enum: "full", "range" full uses the complete source; range requires duration_seconds.
start_seconds number 아니요 0 minimum: 0 Range start in seconds from the source beginning.

TaskError

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
code string 예 — — Machine-readable task error code.
details object 아니요 {} — Public error details, without private storage or provider values.
message string 예 — — Human-readable summary, not a stable branching key.
param string / null 아니요 null — Related public parameter when available.
retryable boolean 아니요 false — Whether retry may help; inspect partial outputs before creating a new paid task.

TaskResponse

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
created_at string 예 — format: date-time UTC acceptance timestamp.
credits CreditUsage 예 — — Quoted, reserved, and charged credit states.
error TaskError / null 아니요 null — Task failure details, independently of any usable outputs.
finished_at string / null 아니요 null format: date-time UTC terminal timestamp when known.
id string 예 — format: uuid Persist this task ID immediately after create; poll it instead of creating again.
metadata object 아니요 {} — Caller-provided metadata.
normalized_input object 아니요 {} — Normalized public input; may contain private prompts or image references. Do not log wholesale.
object string 예 — enum: "video_generation", "animation_export", "animation" Public task resource type.
outputs array<AssetResponse> 아니요 [] — Available assets, including partial outputs on failed/cancelled tasks. Always inspect them at a terminal state.
progress number 예 — minimum: 0; maximum: 1 Fraction from 0 to 1, not a completion-time estimate.
resolved_export ResolvedExport / null 아니요 null — Persisted FPS sampling summary shared with the quote and manifest; null for legacy tasks.
stage string / null 아니요 null enum: "queued", "video_generation", "animation_export", "completed" Current pipeline stage when available.
started_at string / null 아니요 null format: date-time UTC production start when known.
status string 예 — enum: "queued", "running", "cancelling", "succeeded", "failed", "cancelled" succeeded, failed, and cancelled are terminal; cancelling is not terminal.

UnityOptions

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
pivot string 아니요 "bottom_center" const: "bottom_center" Supported Unity sprite pivot.
pixels_per_unit integer 아니요 100 minimum: 1; maximum: 1000 Unity texture pixels per world unit.

UrlImageInput

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
type string 예 — const: "url" —
url string 예 — minLength: 9; maxLength: 2048 Public HTTPS image on port 443, without credentials or fragments. Private networks and unsafe redirects are rejected. Keep bytes stable across retries.

VideoGenerationCreateRequest

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
input GenerationInput 예 — — Images owned by the caller or supplied for this generation.
metadata object 아니요 {} — Caller metadata: simple string/number/boolean/null values, at most 4 KiB JSON. Do not store secrets.
negative_prompt string 아니요 "" maxLength: 4000 Optional exclusions, only when the model supports negative prompts.
prompt string 아니요 "" maxLength: 8000 Motion instruction; nonempty when the model requires a prompt. Keep private prompts out of logs.
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} — Model-compatible generation settings.

VideoGenerationQuoteRequest

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
has_last_frame boolean 아니요 false — Whether the planned request includes a last frame.
reference_image_count integer 아니요 0 minimum: 0; maximum: 8 Number of additional references, excluding the first frame.
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} — Generation options to estimate; must match the later create.

VideoOptions

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
duration_seconds number / null 아니요 null exclusiveMinimum: 0 Seconds; choose a supported duration for the model and resolution. Omission uses its default.
input_canvas InputCanvasOptions / null 아니요 null — Optional input framing; omit to keep the source framing.
model string / null 아니요 null — provider:model ID from GET /models; omission uses the configured default model.
ratio string / null 아니요 null — Aspect ratio supported by the current model and input mode.
resolution string / null 아니요 null — Resolution value from the live model catalog.
seed integer / null 아니요 null minimum: 0; maximum: 2147483647 Optional seed only for models advertising seed support; not a universal determinism guarantee.
style_preset string / null 아니요 null — Optional style preset supported by the selected provider/model.
transparency GenerationTransparency 아니요 {"key_color":null,"key_selection":"auto","mode":"standard"} — Source transparency workflow; transparent exports require alpha_key.
watermark boolean / null 아니요 null — Optional watermark setting; check the model capability.

VideoPreviewRequest

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
max_frame_size integer 아니요 256 minimum: 32; maximum: 512 Maximum thumbnail side in pixels, preserving aspect ratio.
timestamps_seconds array<number> 예 — minItems: 1; maxItems: 12; 항목: minimum: 0 Source timeline timestamps in request order, each strictly before the playable end. At most 12.

VideoPreviewResponse

선언되지 않은 필드는 거부됩니다.

필드 유형 필수 기본값 제약 설명
cells array<PreviewCell> 예 — — Thumbnails in request order, preserving duplicates.
height integer 예 — — Contact sheet height in pixels, including labels and padding.
image AssetResponse 예 — — Cached PNG contact sheet with a refreshable signed download URL.
object string 아니요 "video_preview" const: "video_preview" —
source_video_asset_id string 예 — format: uuid Stable source video asset ID.
width integer 예 — — Contact sheet width in pixels, including labels and padding.

이 문서가 도움이 되었나요?

검색어, 코드 또는 자유 입력 텍스트는 수집하지 않습니다. 이 설정은 문서 상호작용 이벤트만 제어합니다. 개인정보 처리방침

도움이 필요하신가요? 지원팀 문의