MCP tool reference
Generated contracts for all registered MCP tools: arguments, results, OAuth scopes, side effects, spending safeguards, and reviewed availability.
On this page
Availability and workflow
Official MCP is in public beta at https://api.animgen.com/mcp. Use Streamable HTTP and OAuth with a verified AnimGen account; subscriptions raise limits and a connection does not approve spending.
Availability and quickstart · Standard workflow
Tools
| Tool | Scope | Purpose |
|---|---|---|
| list_models | models:read |
List enabled animation models, supported parameters, and capabilities. |
| prepare_image_upload | files:write |
Create a short-lived direct upload. PUT exactly byte_size bytes using the returned URL and headers, then call complete_image_upload. |
| complete_image_upload | files:write |
Validate a prepared image upload and return its reusable file_id. |
| quote_animation | animations:write |
Calculate the current credit price and issue a short-lived quote_id. This does not start generation or spend credits. |
| quote_video_generation | animations:write |
Quote source-video generation only; no export or production starts. |
| generate_animation | animations:write |
Start a paid asynchronous animation. Requires a prior quote_id or an explicit max_credits limit and an idempotency key. Credits may be charged once production begins. |
| generate_video | animations:write |
Start a paid video-only task with approved quote_id or max_credits. Save the task ID, poll get_video_generation, then retain the video asset ID for previews and exports. |
| get_animation | animations:read |
Get animation status, progress, credit state, errors, and generated assets. |
| get_video_generation | animations:read |
Poll an owned source-video task, including partial outputs, measured media metadata and credit state. |
| download_asset | assets:read |
Return metadata and a short-lived signed download URL for an owned output asset. |
| preview_video | assets:read |
Get a labeled contact sheet at up to 12 timestamps, with actual source times. Uses no AI or credits; subject to storage quota and media budgets. Returns a signed image URL, not inline image bytes; fetch it without credentials to inspect. Does not preview final alpha quality. |
| quote_animation_export | animations:write |
Quote an export from an owned source video. FPS exports return a resolved sampling summary and never regenerate the video. |
| export_animation | animations:write |
Start a paid export from an existing video asset with approved quote_id or max_credits. Changing selection or FPS creates a new export only; never regenerates source motion. |
| get_animation_export | animations:read |
Poll an owned export task; inspect resolved_export and outputs even after failure or cancellation. |
| cancel_animation | animations:write |
Best-effort cancellation of an owned animation. Work already in production may not stop and credits already charged are not refunded. |
| cancel_video_generation | animations:write |
Request best-effort cancellation of an owned source-video task. Continue polling; cancellation does not guarantee a refund. |
| cancel_animation_export | animations:write |
Cancel an owned export only; retain the source video for another export. Continue polling until a terminal state. |
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