Quote animation
Source-generated POST /animations/quote reference: authentication, fields, responses, errors, and operational safeguards.
On this page
Operation
POST /animations/quote
operationId: quote_one_click_animation_v1_animations_quote_post
Estimate credits for the intended operation without starting production or charging credits. This is not a price lock or spend authorization. Creation recalculates the current quote; review it before creating. Match the pricing-relevant options to the later request.
Authentication and side effects
Use a server-side Bearer API key. Required scope: animations:write
This operation does not start paid generation. Other state changes are described above.
Parameters
No path, query, or operation-specific header parameters.
Request body (application/json)
Body required: true
| Field | Type | Required | Default | Constraints | Meaning |
|---|---|---|---|---|---|
export |
ExportOptions | No | {"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 | Yes | — | — | Images owned by the caller or supplied for this generation. |
metadata |
object |
No | {} |
— | Caller metadata: simple string/number/boolean/null values, at most 4 KiB JSON. Do not store secrets. |
negative_prompt |
string |
No | "" |
maxLength: 4000 |
Optional exclusions, only when the model supports negative prompts. |
prompt |
string |
No | "" |
maxLength: 8000 |
Motion instruction; nonempty when the model requires a prompt. Keep private prompts out of logs. |
selection |
Selection | No | {"duration_seconds":null,"mode":"full","start_seconds":0} |
— | Interval selected after generation; full by default. |
video |
VideoOptions | No | {"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. |
Full nested schema: AnimationCreateRequest
Request example
{
"export": {
"frame_count": 24,
"output_formats": [
"frames_zip"
],
"output_height": 512,
"output_width": 512
},
"input": {
"first_frame": {
"file_id": "00000000-0000-4000-8000-000000000001",
"type": "file"
}
},
"prompt": "A character runs in place, side view, fixed camera.",
"selection": {
"mode": "full"
}
}
Responses
| HTTP | Body | Meaning |
|---|---|---|
200 |
QuoteResponse | Successful public response. Example values are illustrative. |
400 |
APIErrorEnvelope | Invalid input; correct the request before retrying. |
401 |
APIErrorEnvelope | Missing, expired, or revoked API key. |
402 |
APIErrorEnvelope | Insufficient credits; do not automatically purchase. |
403 |
APIErrorEnvelope | Account eligibility, account status, or key scope does not allow this operation. |
404 |
APIErrorEnvelope | Resource is unavailable, not owned, or its signature is invalid/expired. |
413 |
APIErrorEnvelope | Request or decoded image exceeds the configured limit. |
415 |
APIErrorEnvelope | Use supported image media types. |
422 |
APIErrorEnvelope | Decoded image dimensions exceed the allowed size. |
429 |
APIErrorEnvelope | Account-wide rate or queue limit; wait for Retry-After. |
500 |
APIErrorEnvelope | Internal failure; preserve the task/key and retry only when marked retryable. |
503 |
APIErrorEnvelope | Service/provider unavailable; retry only when error.retryable is true. |
Response headers
| HTTP | Header | Type | Meaning |
|---|---|---|---|
429 |
Retry-After |
integer |
Suggested wait in seconds; respect the server value and an overall deadline. |
503 |
Retry-After |
integer |
Suggested wait in seconds; respect the server value and an overall deadline. |
Response example
{
"breakdown": {},
"credits": 1,
"object": "quote"
}
Related guides
Was this page helpful?
No search queries, code, or free text are collected. This switch controls documentation interactions only; general site analytics follow the privacy policy. Privacy policy