AnimGen
Registrieren
Zum Artikel springen
Dokumentation

Dokumentation durchsuchen

Die Suche bleibt in diesem Browser. Suchbegriffe werden weder gesendet noch gespeichert. Füge keine Zugangsdaten ein.

Öffentlicher Suchindex wird geladen…

Tab oder Pfeiltasten zum Navigieren · Enter zum Öffnen · Esc zum Schließen
English简体中文繁體中文日本語한국어
Dokumentationsverzeichnis

Gemeinsame Schemadefinitionen

Aus dem Quellvertrag erzeugte Felddefinitionen, verschachtelte Typen, Standardwerte, Pflichtangaben und Einschränkungen.

Öffentliche BetaAPI v1 · 1.4.0Zuletzt geprüft
Auf dieser Seite

Ein Strich bedeutet, dass kein Standardwert definiert ist, nicht null. Ein im JSON Schema optionales Feld kann im beschriebenen Workflow bedingt erforderlich sein. Modellspezifische Optionen müssen weiterhin aktuell abgefragt werden.

AccountAPIKey

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
id string Ja — format: uuid Identity of the authenticated key, not its secret. Idempotency is scoped to this identity.
scopes array<string> Ja — — Permissions granted to this key.

AccountLimits

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
concurrency integer Ja — — Maximum concurrent jobs across this account.
create_per_minute integer Ja — — Account-wide create requests per minute.
other_per_minute integer Ja — — Account-wide other requests per minute.
queue integer Ja — — Maximum queued jobs across this account.

AccountPlan

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
cancel_at_period_end boolean Ja — — Whether the current paid subscription will stop renewing; false for registered access.
code string Ja — — Current developer access tier: registered, basic, expert, or ultra.
current_period_end string / null Ja — format: date-time Paid subscription period end in UTC, or null for registered access.

AccountResponse

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
api_key AccountAPIKey Ja — — Current key identity and scopes; never the key secret.
id string Ja — format: uuid Authenticated account ID.
limits AccountLimits Ja — — Limits are shared by every key on this account.
object string Nein "account" const: "account" —
plan AccountPlan Ja — — Current developer access tier and optional subscription period.

AnimationCreateRequest

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
export ExportOptions Nein {"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 Ja — — Images owned by the caller or supplied for this generation.
metadata object Nein {} — Caller metadata: simple string/number/boolean/null values, at most 4 KiB JSON. Do not store secrets.
negative_prompt string Nein "" maxLength: 4000 Optional exclusions, only when the model supports negative prompts.
prompt string Nein "" maxLength: 8000 Motion instruction; nonempty when the model requires a prompt. Keep private prompts out of logs.
selection Selection Nein {"duration_seconds":null,"mode":"full","start_seconds":0} — Interval selected after generation; full by default.
video VideoOptions Nein {"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

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
export ExportOptions Nein {"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 Nein {} — Simple scalar/null metadata; at most 4 KiB JSON, no credentials.
selection Selection Nein {"duration_seconds":null,"mode":"full","start_seconds":0} — Source interval to export.
source_video_asset_id string Ja — format: uuid Owned source video asset ID, not a task ID. Reuse an existing video to avoid generating motion again.

APIError

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
code string Ja — — Stable machine-readable error code.
details object Ja — — Public error-specific fields; inspect without logging private inputs.
message string Ja — — Human-readable explanation; do not branch on exact text.
param string / null Nein — — Related public parameter, if known.
request_id string / null Ja — — Public support correlation ID, not a credential.
retryable boolean Ja — — Retry may help; still preserve idempotency and respect Retry-After.

APIErrorEnvelope

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
error APIError Ja — — —

AssetResponse

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
byte_size integer Ja — — Expected file size in bytes.
created_at string Ja — format: date-time Creation timestamp in UTC.
download_expires_at string Ja — format: date-time Signed URL expiry in UTC; refresh via asset lookup when expired.
download_url string Ja — — Sensitive short-lived signed URL. Download without a Bearer header, including after redirects; never log the URL.
format string Ja — — Artifact format; inspect actual outputs rather than assuming an array order.
id string Ja — format: uuid Stable public asset ID; use it to refresh download metadata.
media MediaResponse / null Nein null — Whitelisted measured video metadata. Unknown fields are null; non-video assets return null.
mime_type string Ja — — Asset media type.
object string Nein "asset" const: "asset" —

Base64ImageInput

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
data string Ja — minLength: 4 Pure Base64 without a data URL prefix; decoded limits: 10 MiB per image, 20 MiB total.
media_type string Ja — enum: "image/png", "image/jpeg", "image/webp" Actual image MIME type.
type string Ja — const: "base64" —

Body_create_file_v1_files_post

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
file string Ja — format: binary PNG, JPEG, or WebP image bytes; validated before returning a public file ID.

CreditsBalanceResponse

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
available integer Ja — — Currently available account credits; not a feature-entitlement flag.
object string Nein "credit_balance" const: "credit_balance" —

CreditUsage

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
charged integer Ja — — Net charged credits. Confirmed provider moderation rejection is refunded; cancellation alone is not a refund.
held integer Ja — — Credits currently reserved, not an additional charge to sum with charged.
quoted integer Ja — — Quoted total, not necessarily the final charge.
refunded integer Nein 0 — Credits returned after a charge; already excluded from charged. Not a cash refund.
released integer Nein 0 — Credits returned from an uncommitted hold.
status string / null Nein null — Billing state: held, charged, released, refunded, or managed for internal child tasks.

ExportOptions

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
fps number / null Nein 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 Nein null minimum: 1; maximum: 240 Legacy uniform frame count, mutually exclusive with fps. When both are omitted, uses 24 frames.
output_formats array<string> Nein ["spritesheet"] minItems: 1; Elemente: 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 Nein 512 minimum: 64; maximum: 1024 Output frame height in pixels.
output_width integer Nein 512 minimum: 64; maximum: 1024 Output frame width in pixels.
transparent ExportTransparency Nein {"enabled":false} — Use the enabled object form. Legacy booleans are accepted but normalized to this object.
unity UnityOptions Nein {"pivot":"bottom_center","pixels_per_unit":100} — Settings for Unity-specific metadata and packs.

ExportTransparency

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
enabled boolean Nein false — Transparent processing for compatible outputs; requires an alpha_key source and does not make MP4 transparent.

ExportWarning

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
code string Ja — — —
details object Nein {} — —
message string Ja — — —

FileImageInput

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
file_id string Ja — format: uuid Owned public file ID from POST /files or complete_image_upload; not a Studio upload ID.
type string Ja — const: "file" —

FileResponse

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
byte_size integer Ja — — Stored image byte count.
created_at string Ja — format: date-time UTC upload creation time.
height integer Ja — — Decoded image height in pixels.
id string Ja — format: uuid Reusable public file ID for type=file inputs.
mime_type string Ja — — Validated image media type.
object string Nein "file" const: "file" —
sha256 string Ja — — SHA-256 of the image bytes.
width integer Ja — — Decoded image width in pixels.

GenerationInput

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
first_frame FileImageInput / Base64ImageInput / UrlImageInput Ja — discriminator: type Required starting image; use the type discriminator to select an input representation.
last_frame FileImageInput / Base64ImageInput / UrlImageInput / null Nein null discriminator: type Optional end image; the selected model must support first/last-frame mode.
reference_images array<FileImageInput / Base64ImageInput / UrlImageInput> Nein [] maxItems: 8; Elemente: discriminator: type Additional references, excluding the first frame. The live model can impose a smaller limit.

GenerationTransparency

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
key_color string / null Nein null — Temporary key color when using manual selection; normally leave automatic selection enabled.
key_selection string Nein "auto" enum: "auto", "manual" How the temporary key color is selected.
mode string Nein "standard" enum: "standard", "alpha_key" standard keeps the scene; alpha_key requires meaningful alpha in all active input images. Raw videos remain opaque.

InputCanvasOptions

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
aspect_ratio string Nein "follow_output" enum: "follow_output", "source" Follow the output ratio or preserve the source ratio.
background string Nein "auto" enum: "auto", "transparent", "solid" Canvas extension background strategy.
background_color string / null Nein null pattern: ^#[0-9A-Fa-f]{6}$ Six-digit RGB color for a solid extension.
enabled boolean Nein true — Whether to prepare an expanded input canvas.
position_x number Nein 0.5 minimum: 0; maximum: 1 Normalized horizontal source position.
position_y number Nein 0.5 minimum: 0; maximum: 1 Normalized vertical source position.
source_scale number Nein 0.8 minimum: 0.5; maximum: 1 Source subject scale within the canvas.

MediaResponse

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
duration_seconds number / null Nein null — Playable video duration measured from presentation timestamps; never provider-requested duration.
fps number / null Nein null — Measured average source frame rate; use presentation timestamps for VFR selection.
frame_count integer / null Nein null — Decoded source frame count, or null when unknown.
height integer / null Nein null — Displayed video height in pixels, accounting for rotation.
width integer / null Nein null — Displayed video width in pixels, accounting for rotation.

ModelCapabilities

Unbekannte Felder werden abgelehnt.

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

ModelsResponse

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
data array<ModelCapabilities> Ja — — Currently enabled models; do not hard-code this list in a client.
object string Nein "list" const: "list" —

PreviewCell

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
index integer Ja — minimum: 0 Zero-based position in the original timestamp request.
rect PreviewRect Ja — — Image area within the contact sheet; excludes the timestamp label.
requested_time_seconds number Ja — — Requested time relative to the playable source origin.
source_time_seconds number Ja — — Presentation time of the source frame displayed at the requested time.

PreviewRect

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
height integer Ja — exclusiveMinimum: 0 Thumbnail height, excluding padding and label.
width integer Ja — exclusiveMinimum: 0 Thumbnail width, excluding padding and label.
x integer Ja — minimum: 0 Left pixel from the sheet origin.
y integer Ja — minimum: 0 Top pixel from the sheet origin.

QuoteResponse

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
breakdown object Nein {} — Public cost components; use credits as the quoted total.
credits integer Ja — — Current estimated credits. No price lock or spend authorization; creation recalculates the quote.
object string Nein "quote" const: "quote" —
resolved_export ResolvedExport / null Nein null — Final sampling summary for an FPS export from an existing source; null for legacy or generation quotes.

ResolvedExport

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
duration_ms integer Ja — — Sum of manifest frame durations in milliseconds.
fps number Ja — — Target sampling frequency; never recalculated as frame_count / duration.
frame_count integer Ja — — Number of samples strictly before the selected end.
selection Selection Ja — — Resolved source interval; full uses measured playable duration.
warnings array<ExportWarning> Nein [] — Sampling warnings, including repeated source frames without interpolation.

Selection

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
duration_seconds number / null Nein null exclusiveMinimum: 0 Required when mode=range; positive interval length in seconds.
mode string Nein "full" enum: "full", "range" full uses the complete source; range requires duration_seconds.
start_seconds number Nein 0 minimum: 0 Range start in seconds from the source beginning.

TaskError

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
code string Ja — — Machine-readable task error code.
details object Nein {} — Public error details, without private storage or provider values.
message string Ja — — Human-readable summary, not a stable branching key.
param string / null Nein null — Related public parameter when available.
retryable boolean Nein false — Whether retry may help; inspect partial outputs before creating a new paid task.

TaskListResponse

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
data array<TaskResponse> Ja — — Owned tasks in this page.
next_cursor string / null Nein null — Opaque next-page cursor; null means no next page. Pass it unchanged.
object string Nein "list" const: "list" —

TaskResponse

Unbekannte Felder werden abgelehnt.

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

UnityOptions

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
pivot string Nein "bottom_center" const: "bottom_center" Supported Unity sprite pivot.
pixels_per_unit integer Nein 100 minimum: 1; maximum: 1000 Unity texture pixels per world unit.

UrlImageInput

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
type string Ja — const: "url" —
url string Ja — 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

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
input GenerationInput Ja — — Images owned by the caller or supplied for this generation.
metadata object Nein {} — Caller metadata: simple string/number/boolean/null values, at most 4 KiB JSON. Do not store secrets.
negative_prompt string Nein "" maxLength: 4000 Optional exclusions, only when the model supports negative prompts.
prompt string Nein "" maxLength: 8000 Motion instruction; nonempty when the model requires a prompt. Keep private prompts out of logs.
video VideoOptions Nein {"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

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
has_last_frame boolean Nein false — Whether the planned request includes a last frame.
reference_image_count integer Nein 0 minimum: 0; maximum: 8 Number of additional references, excluding the first frame.
video VideoOptions Nein {"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

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
duration_seconds number / null Nein null exclusiveMinimum: 0 Seconds; choose a supported duration for the model and resolution. Omission uses its default.
input_canvas InputCanvasOptions / null Nein null — Optional input framing; omit to keep the source framing.
model string / null Nein null — provider:model ID from GET /models; omission uses the configured default model.
ratio string / null Nein null — Aspect ratio supported by the current model and input mode.
resolution string / null Nein null — Resolution value from the live model catalog.
seed integer / null Nein null minimum: 0; maximum: 2147483647 Optional seed only for models advertising seed support; not a universal determinism guarantee.
style_preset string / null Nein null — Optional style preset supported by the selected provider/model.
transparency GenerationTransparency Nein {"key_color":null,"key_selection":"auto","mode":"standard"} — Source transparency workflow; transparent exports require alpha_key.
watermark boolean / null Nein null — Optional watermark setting; check the model capability.

VideoPreviewRequest

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
max_frame_size integer Nein 256 minimum: 32; maximum: 512 Maximum thumbnail side in pixels, preserving aspect ratio.
timestamps_seconds array<number> Ja — minItems: 1; maxItems: 12; Elemente: minimum: 0 Source timeline timestamps in request order, each strictly before the playable end. At most 12.

VideoPreviewResponse

Unbekannte Felder werden abgelehnt.

Feld Typ Erforderlich Standardwert Einschränkungen Bedeutung
cells array<PreviewCell> Ja — — Thumbnails in request order, preserving duplicates.
height integer Ja — — Contact sheet height in pixels, including labels and padding.
image AssetResponse Ja — — Cached PNG contact sheet with a refreshable signed download URL.
object string Nein "video_preview" const: "video_preview" —
source_video_asset_id string Ja — format: uuid Stable source video asset ID.
width integer Ja — — Contact sheet width in pixels, including labels and padding.

War diese Seite hilfreich?

Es werden keine Suchbegriffe, Codes oder Freitexte erfasst. Dieser Schalter steuert nur Dokumentationsinteraktionen; allgemeine Website-Analysen folgen der Datenschutzerklärung. Datenschutzerklärung

Brauchst du Hilfe? Support kontaktieren