AnimGen
新規登録
本文へ移動
使い方

ドキュメントを検索

検索はブラウザー内で行われ、入力した語句は送信・保存されません。認証情報は入力しないでください。

検索データを読み込み中…

Tab または矢印キーで移動 · Enter で開く · Esc で閉じる
English简体中文繁體中文
ドキュメントを探す

共通スキーマ定義

ソースコード由来のフィールド、入れ子の型、既定値、必須指定、制約です。

公開ベータAPI v1 · 1.4.0最終確認
このページの目次

「—」は既定値が未定義という意味で、nullではありません。JSON Schemaで任意でも手順上は条件付きで必須になる場合があります。モデル固有の選択肢は現在の能力を取得してください。

AccountAPIKey

未定義のフィールドは拒否されます。

フィールド 型 必須 既定値 制約 説明
id string はい — format: uuid Identity of the authenticated key, not its secret. Idempotency is scoped to this identity.
scopes array<string> はい — — Permissions granted to this key.

AccountLimits

未定義のフィールドは拒否されます。

フィールド 型 必須 既定値 制約 説明
concurrency integer はい — — Maximum concurrent jobs across this account.
create_per_minute integer はい — — Account-wide create requests per minute.
other_per_minute integer はい — — Account-wide other requests per minute.
queue integer はい — — Maximum queued jobs across this account.

AccountPlan

未定義のフィールドは拒否されます。

フィールド 型 必須 既定値 制約 説明
cancel_at_period_end boolean はい — — Whether the current paid subscription will stop renewing; false for registered access.
code string はい — — Current developer access tier: registered, basic, expert, or ultra.
current_period_end string / null はい — format: date-time Paid subscription period end in UTC, or null for registered access.

AccountResponse

未定義のフィールドは拒否されます。

フィールド 型 必須 既定値 制約 説明
api_key AccountAPIKey はい — — Current key identity and scopes; never the key secret.
id string はい — format: uuid Authenticated account ID.
limits AccountLimits はい — — Limits are shared by every key on this account.
object string いいえ "account" const: "account" —
plan AccountPlan はい — — Current developer access tier and optional subscription period.

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.

APIError

フィールド 型 必須 既定値 制約 説明
code string はい — — Stable machine-readable error code.
details object はい — — Public error-specific fields; inspect without logging private inputs.
message string はい — — Human-readable explanation; do not branch on exact text.
param string / null いいえ — — Related public parameter, if known.
request_id string / null はい — — Public support correlation ID, not a credential.
retryable boolean はい — — Retry may help; still preserve idempotency and respect Retry-After.

APIErrorEnvelope

フィールド 型 必須 既定値 制約 説明
error APIError はい — — —

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" —

Body_create_file_v1_files_post

フィールド 型 必須 既定値 制約 説明
file string はい — format: binary PNG, JPEG, or WebP image bytes; validated before returning a public file ID.

CreditsBalanceResponse

未定義のフィールドは拒否されます。

フィールド 型 必須 既定値 制約 説明
available integer はい — — Currently available account credits; not a feature-entitlement flag.
object string いいえ "credit_balance" const: "credit_balance" —

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" —

FileResponse

未定義のフィールドは拒否されます。

フィールド 型 必須 既定値 制約 説明
byte_size integer はい — — Stored image byte count.
created_at string はい — format: date-time UTC upload creation time.
height integer はい — — Decoded image height in pixels.
id string はい — format: uuid Reusable public file ID for type=file inputs.
mime_type string はい — — Validated image media type.
object string いいえ "file" const: "file" —
sha256 string はい — — SHA-256 of the image bytes.
width integer はい — — Decoded image width in pixels.

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.

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.

QuoteResponse

未定義のフィールドは拒否されます。

フィールド 型 必須 既定値 制約 説明
breakdown object いいえ {} — Public cost components; use credits as the quoted total.
credits integer はい — — Current estimated credits. No price lock or spend authorization; creation recalculates the quote.
object string いいえ "quote" const: "quote" —
resolved_export ResolvedExport / null いいえ null — Final sampling summary for an FPS export from an existing source; null for legacy or generation quotes.

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.

TaskListResponse

未定義のフィールドは拒否されます。

フィールド 型 必須 既定値 制約 説明
data array<TaskResponse> はい — — Owned tasks in this page.
next_cursor string / null いいえ null — Opaque next-page cursor; null means no next page. Pass it unchanged.
object string いいえ "list" const: "list" —

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.

この記事は役に立ちましたか？

検索語句、コード、自由記述は収集しません。この設定はドキュメントの操作イベントのみを制御します。 プライバシーポリシー

お困りですか？サポートへ