{ "openapi": "3.0.0", "info": { "version": "0.9.10", "title": "Ludo.ai API", "description": "The Ludo.ai API enables you to generate game assets programmatically, including images, videos, 3D models, spritesheets, and audio.\n\n# Getting Started\n\n## Base URL\nAll API requests should be made to: `https://api.ludo.ai/api`\n\n## Authentication\nInclude your API key in the `Authorization` header:\n```\nAuthorization: ApiKey YOUR_API_KEY\n```\n\n## Models\nPick from the current models for any new integration:\n\n- `hydra` (Hydra) - Most capable all-around model, generates audio.\n- `hydra-plus` (Hydra+) - Hydra but with better fine details. Slower generations.\n- `forge` (Forge) - Sharper detail, simpler motion. Best for simple body shapes and short actions; may need a few tries.\n- `forge-pixel` (Forge Pixel) - Best for low-res pixel art animations\n- `griffin` (Griffin) - Fast cinematic videos in any style, with audio, 480p.\n- `griffin-hd` (Griffin HD) - Same as Griffin, but in 720p.\n\nWhich models each action accepts (in preference order):\n\n- sprite animation: `hydra`, `hydra-plus`, `forge`, `forge-pixel`\n- motion transfer: `hydra`, `forge`, `forge-pixel`\n- spritesheet editing: `hydra`, `forge`, `forge-pixel`\n- new view: `hydra`, `hydra-plus`\n- video generation: `griffin`, `griffin-hd`\n- references to video: `griffin`, `griffin-hd`\n- video editing: `griffin-hd`\n\n**Legacy models** are still accepted so existing integrations keep working, but they are scheduled for removal - do not use them for new work:\n\n- `blitz` (Blitz) - legacy since 2026-09-17\n- `eagle` (Eagle) - legacy since 2026-09-17\n- `eagle-audio` (Eagle with Audio) - legacy since 2026-09-17\n- `tango` (Tango) - legacy since 2026-09-17\n\nEach generation endpoint lists its own models, rates and durations in its `model` parameter description.\n\n## Timeout\nGeneration requests return `202` immediately (see below) and hold no connection open while the work runs. If you opt into a synchronous response with `async: false`, include a generous timeout (at least 20 minutes): the call is held for at most 15 minutes, and past that you receive `202` with the job instead of an error and resume with `GET /assets/jobs/{id}`.\n\n## Documentation\n`GET /docs/search?query=...` searches Ludo's feature guides with a plain-language\nquestion and returns the few sections that answer it (each names a `doc` and\n`section`). `GET /docs` lists every document and section, and `GET /docs?doc=...`\nreads one in full. Both are free (no credits) and rate-limited: 60 requests per 5 minutes\nand 1000 per day for search, 150 per 5 minutes for reading. Read the relevant guide before\nyour first call to a generator: it explains modes, models, margins and known limitations.\n\n## Async Usage\nGeneration endpoints are asynchronous: you submit the work, get a job id back, and\ncollect the result when it is ready. Nothing is held open while a GPU runs.\n\n1. **Submit** the generation. The API responds immediately with\n `202 { id, status: \"queued\" }`.\n2. **Poll** `GET /assets/jobs/{id}` until `status` is `succeeded` or `failed`.\n Non-terminal responses carry `poll_after_ms` - wait at least that long before the\n next poll. Better still, long-poll: `GET /assets/jobs/{id}?wait=30` holds the\n request up to 30 s (max 60) and returns the moment the job finishes.\n3. **Read** `result` - it is exactly the response documented for that operation. On a\n failure, read `error` instead.\n\n`GET /assets/jobs` lists your recent jobs, and `DELETE /assets/jobs/{id}` cancels one\nthat has not finished yet (credits are refunded).\n\nJob-status endpoints are rate-limited to 150 requests per 5 minutes per API key; a\n`429` carries `Retry-After`. Each account may have up to 50 generations queued or\nrunning at once via the API; a request beyond that returns `429` (code\n`PENDING_JOBS_LIMIT`) - wait for jobs to finish, then submit again.\n\n### Synchronous responses (deprecated)\nPassing `async: false` in the payload opts into a synchronous response: the call blocks\nuntil the result is ready and returns it as the response body. This is deprecated, but\nthe opt-out is permanent and stays supported.\n\nSynchronous calls run on the same queue: the response carries an `X-Ludo-Job-Id`\nheader, and if the job is still running after 15 minutes you receive `202` with the job\ninstead of an error - resume with `GET /assets/jobs/{id}`.\n\nThe legacy `request_id` + `GET /assets/{type}/results` flow keeps working unchanged.\n\n### Legacy results endpoints\nEach asset type still has a results endpoint:\n- `GET /assets/images/results` - images\n- `GET /assets/sprites/results` - spritesheets\n- `GET /assets/videos/results` - videos\n- `GET /assets/audio/results` - audio\n- `GET /assets/3d-models/results` - 3D models\n\nResults are available for 7 days and return the 100 most recent API-generated assets. The `request_id` query parameter is optional - omit it to list all recent results.\n\n## Asset URL Expiration\nAll generated asset URLs (images, spritesheets, videos, audio, 3D models) are temporary and expire after **7 days**. If you need to keep an asset, download it before it expires.\n\n## Request Format\n- Use `Content-Type: application/json` for all requests\n- All responses are returned in JSON format\n\n## Credits\nEach API call consumes credits from your account. The credit cost varies by endpoint and is documented in each endpoint's description.\n\n> **Note:** All API requests consume credits, even if your subscription includes unlimited credits for the web application. Check your account dashboard for your current API credit balance.\n", "x-logo": { "url": "/static/logo-small.png", "altText": "Logo" }, "x-model-lineup": "Current models: hydra (Hydra) - Most capable all-around model, generates audio. hydra-plus (Hydra+) - Hydra but with better fine details. Slower generations. forge (Forge) - Sharper detail, simpler motion. Best for simple body shapes and short actions; may need a few tries. forge-pixel (Forge Pixel) - Best for low-res pixel art animations. griffin (Griffin) - Fast cinematic videos in any style, with audio, 480p. griffin-hd (Griffin HD) - Same as Griffin, but in 720p. Per action - sprite animation: hydra, hydra-plus, forge, forge-pixel; motion transfer: hydra, forge, forge-pixel; spritesheet editing: hydra, forge, forge-pixel; new view: hydra, hydra-plus; video generation: griffin, griffin-hd; references to video: griffin, griffin-hd; video editing: griffin-hd. LEGACY models, still accepted but scheduled for removal - do not use them for new work: blitz, eagle, eagle-audio, tango." }, "paths": { "/auth/validate-api-key": { "get": { "description": "Validates an API key. Returns 200 if valid, 403 if invalid.", "tags": [ "Authentication" ], "operationId": "validateApiKeyEndpoint", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Valid API key" }, "403": { "description": "Invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/auth/validate-api-key\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/auth/validate-api-key\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/auth/validate-api-key\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/image": { "post": { "summary": "createImage", "tags": [ "Images" ], "operationId": "createImage", "x-credit-action": "GENERATE_IMAGE", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateImagePayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImageResult" } } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/image\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"image_type\":\"generic\",\"prompt\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/image\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"image_type\": \"generic\",\n \"prompt\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/image\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"image_type\": \"generic\",\n \"prompt\": \"string\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 0.5 credits per result", "x-credit-summary": "This endpoint consumes 0.5 credits per result", "description": "Generate game-art images from a text prompt alone, selecting an image_type (e.g. sprite) and optionally art_style, perspective, and aspect_ratio. The job result is an array of image results, each with a url; request n (1-8) to control how many variations come back. Because it generates purely from text it takes no source image, so there is no upload size limit to trip. Credits are held when the job is accepted and refunded if it fails or is cancelled; the charge scales with the number of images produced. Use createImage to make new images from scratch; use generateWithStyle to match a reference image's art style, editImage to modify an existing image, and removeBackground to cut out a subject. Pass an optional request_id to tag the results so you can retrieve them later via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 0.5 credits per result.", "x-mcp-description": "Generate game-art images from a text prompt alone, selecting an image_type (e.g. sprite) and optionally art_style, perspective, and aspect_ratio. The job result is an array of image results, each with a url; request n (1-8) to control how many variations come back. Because it generates purely from text it takes no source image, so there is no upload size limit to trip. Credits are held when the job is accepted and refunded if it fails or is cancelled; the charge scales with the number of images produced. Use createImage to make new images from scratch; use generateWithStyle to match a reference image's art style, editImage to modify an existing image, and removeBackground to cut out a subject. Pass an optional request_id to tag the results so you can retrieve them later via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 0.5 credits per result." } }, "/assets/image/style": { "post": { "summary": "generateWithStyle", "tags": [ "Images" ], "operationId": "generateWithStyle", "x-credit-action": "GENERATE_IMAGE", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateWithStylePayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImageResult" } } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/image/style\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"style_image\":\" OR data:image/png;base64,...\",\"prompt\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/image/style\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"style_image\": \" OR data:image/png;base64,...\",\n \"prompt\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/image/style\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"style_image\": \" OR data:image/png;base64,...\",\n \"prompt\": \"string\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 0.5 credits per result", "x-credit-summary": "This endpoint consumes 0.5 credits per result", "description": "Generate new images that match the visual style of a reference image: supply a style_image (URL or base64) plus a text prompt describing what to create and an optional image_type (defaults to sprite). The job result is an array of image results, each with a url; request n (1-4) to control the number of variations. The style_image is uploaded and validated, and an image larger than 15MB is rejected with HTTP 400. Credits are held when the job is accepted and refunded if it fails or is cancelled; the charge scales with the number of images produced. Use this instead of createImage when style consistency with an existing asset matters; use editImage to alter the content of a specific image rather than borrow its style, and removeBackground to isolate a subject. Pass an optional request_id to tag the results so you can retrieve them later via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 0.5 credits per result.", "x-mcp-description": "Generate new images that match the visual style of a reference image: supply a style_image (URL or base64) plus a text prompt describing what to create and an optional image_type (defaults to sprite). The job result is an array of image results, each with a url; request n (1-4) to control the number of variations. The style_image is uploaded and validated, and an image larger than 15MB is rejected with HTTP 400. Credits are held when the job is accepted and refunded if it fails or is cancelled; the charge scales with the number of images produced. Use this instead of createImage when style consistency with an existing asset matters; use editImage to alter the content of a specific image rather than borrow its style, and removeBackground to isolate a subject. Pass an optional request_id to tag the results so you can retrieve them later via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 0.5 credits per result." } }, "/assets/image/edit": { "post": { "summary": "editImage", "tags": [ "Images" ], "operationId": "editImage", "x-credit-action": "GENERATE_IMAGE", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditImagePayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImageResult" } } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/image/edit\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"image\":\" OR data:image/png;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/image/edit\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"image\": \" OR data:image/png;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/image/edit\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"image\": \" OR data:image/png;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 0.5 credits per result; 1 credit per result with a mask", "x-credit-summary": "This endpoint consumes 0.5 credits per result; 1 credit per result with a mask", "description": "Modify an existing image according to text instructions: supply a source image (URL or base64) and a prompt describing the changes (e.g. \"add clouds\", \"warmer color scheme\"), with an optional reference_image for extra style or content guidance. To change only one area, pass a mask (white = change, black = keep, the same size as the image): mask_mode \"replace\" (default) redraws that area from the prompt, \"erase\" removes what is there. Without a mask the whole image is re-rendered. The job result is an array of image results, each with a url; request n (1-4) to control the number of edited variations. Provided images are uploaded and validated, and any image larger than 15MB is rejected with HTTP 400. Credits are held when the job is accepted and refunded if it fails or is cancelled; the charge scales with the number of images produced. Use editImage to transform a specific existing image; use createImage to generate from text alone, generateWithStyle to borrow a reference's art style, and removeBackground for the dedicated background-removal case. Pass an optional request_id to tag the results so you can retrieve them later via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 0.5 credits per result; 1 credit per result with a mask.", "x-mcp-description": "Modify an existing image according to text instructions: supply a source image (URL or base64) and a prompt describing the changes (e.g. \"add clouds\", \"warmer color scheme\"), with an optional reference_image for extra style or content guidance. To change only one area, pass a mask (white = change, black = keep, the same size as the image): mask_mode \"replace\" (default) redraws that area from the prompt, \"erase\" removes what is there. Without a mask the whole image is re-rendered. The job result is an array of image results, each with a url; request n (1-4) to control the number of edited variations. Provided images are uploaded and validated, and any image larger than 15MB is rejected with HTTP 400. Credits are held when the job is accepted and refunded if it fails or is cancelled; the charge scales with the number of images produced. Use editImage to transform a specific existing image; use createImage to generate from text alone, generateWithStyle to borrow a reference's art style, and removeBackground for the dedicated background-removal case. Pass an optional request_id to tag the results so you can retrieve them later via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 0.5 credits per result; 1 credit per result with a mask." } }, "/assets/sprite/animate": { "post": { "summary": "animateSprite", "tags": [ "Spritesheets" ], "operationId": "animateSprite", "x-credit-action": "ANIMATE_SPRITE", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnimateSpritePayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpriteResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/animate\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"motion_prompt\":\"string\",\"initial_image\":\" OR data:image/png;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/animate\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"motion_prompt\": \"string\",\n \"initial_image\": \" OR data:image/png;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/animate\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"motion_prompt\": \"string\",\n \"initial_image\": \" OR data:image/png;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Hydra (3 credits/s, shortest duration 3s, so 9 credits minimum; 3s = 9, 3.5s = 10.5, 4s = 12, 4.5s = 13.5, 5s = 15) · Hydra+ (4 credits/s, shortest duration 3s, so 12 credits minimum; 3s = 12, 3.5s = 14, 4s = 16, 4.5s = 18, 5s = 20) · Forge (1.5 credits/s; 1s = 1.5, 1.5s = 2.3, 2s = 3, 2.5s = 3.8, 3s = 4.5, 3.5s = 5.3, 4s = 6, 4.5s = 6.8, 5s = 7.5) · Forge Pixel (1.5 credits/s; 1s = 1.5, 1.5s = 2.3, 2s = 3, 2.5s = 3.8, 3s = 4.5, 3.5s = 5.3, 4s = 6, 4.5s = 6.8, 5s = 7.5) · Blitz (1.9 credits/s, minimum charge 4 credits per generation; 1.2s = 4, 1.5s = 4, 2s = 4, 2.5s = 4.8, 3s = 5.7, 3.5s = 6.7, 4s = 7.6) - LEGACY - scheduled for removal, do not use for new work · Eagle (2.6 credits/s, minimum charge 4 credits per generation; 1s = 4, 2s = 5.2, 3s = 7.8, 4s = 10.4) - LEGACY - scheduled for removal, do not use for new work · Eagle with Audio (3.1 credits/s, minimum charge 4 credits per generation; 1s = 4, 2s = 6.2, 3s = 9.3, 4s = 12.4) - LEGACY - scheduled for removal, do not use for new work", "x-credit-summary": "credits/s × seconds, per model: Hydra 3/s (shortest duration 3s, so 9 credits minimum), Hydra+ 4/s (shortest duration 3s, so 12 credits minimum), Forge 1.5/s, Forge Pixel 1.5/s, Blitz 1.9/s (min charge 4 credits) [LEGACY], Eagle 2.6/s (min charge 4 credits) [LEGACY], Eagle with Audio 3.1/s (min charge 4 credits) [LEGACY]; [LEGACY] models are scheduled for removal - do not use them for new work; see this endpoint's full pricing table in the API docs", "description": "Animate a static sprite into a spritesheet driven by a motion text prompt (image-to-spritesheet): supply an initial_image (URL or base64) plus a motion_prompt like \"walking\" or \"attack slash\", and optionally a final_image to interpolate between a start and end frame. Describe the motion exactly and unambiguously, but do not over-describe it: an action the model already knows is one phrase, not a sequence of steps, and the character, art style, background and camera come from the image, not the prompt. For animations driven by up to three keyframes (including a middle frame), use animateSpriteKeyframes instead. The job result is a single sprite result: `spritesheet_url` (the sheet image), `video_url` (an mp4 of the animation - pass it as `video` to transferMotion or as `spritesheet_video_url` to createSpriteAudio; editSpritesheet takes `spritesheet_url`), `num_frames`/`num_cols`/`num_rows` (the grid layout), and, when requested, `gif_url`, `individual_frame_urls` and `spritesheet_with_background_url`. The hydra and hydra-plus models also return `audio_url`, a sound effect for the animation - there is no need to call createSpriteAudio afterwards; forge and forge-pixel produce no audio. The chosen model must support sprite animation and the duration must be valid for it; incompatible model/duration combinations return HTTP 400. Credits are held for the duration you requested when the job is accepted; the final charge is rate × seconds of video generated (legacy models keep their minimum charge), never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. The returned sheet is then trimmed to its best loop and can run slightly shorter than the video; that trim is not deducted. Choosing a tool: animateSprite (this one) when you can describe the motion in text; transferMotion when you want an exact motion copied from a reference video or one of the named presets from listAnimationPresets (e.g. a standard walk or attack cycle); generatePose first when the source image is not yet in the pose the animation should start from. Omit `model` to run on hydra (the default) - see the `model` field for the per-model rates. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Hydra (3 credits/s, shortest duration 3s, so 9 credits minimum; 3s = 9, 3.5s = 10.5, 4s = 12, 4.5s = 13.5, 5s = 15) · Hydra+ (4 credits/s, shortest duration 3s, so 12 credits minimum; 3s = 12, 3.5s = 14, 4s = 16, 4.5s = 18, 5s = 20) · Forge (1.5 credits/s; 1s = 1.5, 1.5s = 2.3, 2s = 3, 2.5s = 3.8, 3s = 4.5, 3.5s = 5.3, 4s = 6, 4.5s = 6.8, 5s = 7.5) · Forge Pixel (1.5 credits/s; 1s = 1.5, 1.5s = 2.3, 2s = 3, 2.5s = 3.8, 3s = 4.5, 3.5s = 5.3, 4s = 6, 4.5s = 6.8, 5s = 7.5) · Blitz (1.9 credits/s, minimum charge 4 credits per generation; 1.2s = 4, 1.5s = 4, 2s = 4, 2.5s = 4.8, 3s = 5.7, 3.5s = 6.7, 4s = 7.6) - LEGACY - scheduled for removal, do not use for new work · Eagle (2.6 credits/s, minimum charge 4 credits per generation; 1s = 4, 2s = 5.2, 3s = 7.8, 4s = 10.4) - LEGACY - scheduled for removal, do not use for new work · Eagle with Audio (3.1 credits/s, minimum charge 4 credits per generation; 1s = 4, 2s = 6.2, 3s = 9.3, 4s = 12.4) - LEGACY - scheduled for removal, do not use for new work.", "x-mcp-description": "Animate a static sprite into a spritesheet driven by a motion text prompt (image-to-spritesheet): supply an initial_image (URL or base64) plus a motion_prompt like \"walking\" or \"attack slash\", and optionally a final_image to interpolate between a start and end frame. Describe the motion exactly and unambiguously, but do not over-describe it: an action the model already knows is one phrase, not a sequence of steps, and the character, art style, background and camera come from the image, not the prompt. For animations driven by up to three keyframes (including a middle frame), use animateSpriteKeyframes instead. The job result is a single sprite result: `spritesheet_url` (the sheet image), `video_url` (an mp4 of the animation - pass it as `video` to transferMotion or as `spritesheet_video_url` to createSpriteAudio; editSpritesheet takes `spritesheet_url`), `num_frames`/`num_cols`/`num_rows` (the grid layout), and, when requested, `gif_url`, `individual_frame_urls` and `spritesheet_with_background_url`. The hydra and hydra-plus models also return `audio_url`, a sound effect for the animation - there is no need to call createSpriteAudio afterwards; forge and forge-pixel produce no audio. The chosen model must support sprite animation and the duration must be valid for it; incompatible model/duration combinations return HTTP 400. Credits are held for the duration you requested when the job is accepted; the final charge is rate × seconds of video generated (legacy models keep their minimum charge), never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. The returned sheet is then trimmed to its best loop and can run slightly shorter than the video; that trim is not deducted. Choosing a tool: animateSprite (this one) when you can describe the motion in text; transferMotion when you want an exact motion copied from a reference video or one of the named presets from listAnimationPresets (e.g. a standard walk or attack cycle); generatePose first when the source image is not yet in the pose the animation should start from. Omit `model` to run on hydra (the default) - see the `model` field for the per-model rates. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: credits/s × seconds, per model: Hydra 3/s (shortest duration 3s, so 9 credits minimum), Hydra+ 4/s (shortest duration 3s, so 12 credits minimum), Forge 1.5/s, Forge Pixel 1.5/s, Blitz 1.9/s (min charge 4 credits) [LEGACY], Eagle 2.6/s (min charge 4 credits) [LEGACY], Eagle with Audio 3.1/s (min charge 4 credits) [LEGACY]; [LEGACY] models are scheduled for removal - do not use them for new work; see this endpoint's full pricing table in the API docs." } }, "/assets/sprite/animate-keyframes": { "post": { "summary": "animateSpriteKeyframes", "tags": [ "Spritesheets" ], "operationId": "animateSpriteKeyframes", "x-credit-action": "ANIMATE_SPRITE", "x-credit-models": [ "hydra", "hydra-plus", "forge", "forge-pixel" ], "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnimateSpriteKeyframesPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpriteResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/animate-keyframes\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"motion_prompt\":\"string\",\"initial_image\":\" OR data:image/png;base64,...\",\"middle_image\":\" OR data:image/png;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/animate-keyframes\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"motion_prompt\": \"string\",\n \"initial_image\": \" OR data:image/png;base64,...\",\n \"middle_image\": \" OR data:image/png;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/animate-keyframes\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"motion_prompt\": \"string\",\n \"initial_image\": \" OR data:image/png;base64,...\",\n \"middle_image\": \" OR data:image/png;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Hydra (3 credits/s, shortest duration 3s, so 9 credits minimum; 3s = 9, 3.5s = 10.5, 4s = 12, 4.5s = 13.5, 5s = 15) · Hydra+ (4 credits/s, shortest duration 3s, so 12 credits minimum; 3s = 12, 3.5s = 14, 4s = 16, 4.5s = 18, 5s = 20) · Forge (1.5 credits/s; 1s = 1.5, 1.5s = 2.3, 2s = 3, 2.5s = 3.8, 3s = 4.5, 3.5s = 5.3, 4s = 6, 4.5s = 6.8, 5s = 7.5) · Forge Pixel (1.5 credits/s; 1s = 1.5, 1.5s = 2.3, 2s = 3, 2.5s = 3.8, 3s = 4.5, 3.5s = 5.3, 4s = 6, 4.5s = 6.8, 5s = 7.5)", "x-credit-summary": "credits/s × seconds, per model: Hydra 3/s (shortest duration 3s, so 9 credits minimum), Hydra+ 4/s (shortest duration 3s, so 12 credits minimum), Forge 1.5/s, Forge Pixel 1.5/s; see this endpoint's full pricing table in the API docs", "description": "Animate a sprite through up to three fixed keyframes - initial_image, middle_image and final_image (each a URL or base64) - producing a spritesheet that interpolates through the provided frames in order. At least one of initial_image or middle_image is required (a final_image alone has nothing to anchor the animation); any keyframe may be omitted. The motion_prompt is optional here - when omitted, the motion is derived purely from the keyframes. Runs on hydra (default; also returns `audio_url`), hydra-plus (hydra with finer detail, also returns `audio_url`), forge, or forge-pixel for pixel-art sprites - the models that support a middle keyframe; any other model returns HTTP 400. For just a start and end frame, animateSprite with `final_image` does the same job. The job result is the same sprite result as animateSprite (`spritesheet_url`, `video_url`, grid fields, optional GIF and frame URLs, `audio_url` on hydra and hydra-plus). Credits are held for the duration you requested when the job is accepted; the final charge is rate × seconds of video generated, never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. The returned sheet is then trimmed to its best loop and can run slightly shorter than the video; that trim is not deducted. Use animateSprite instead for the classic single-image + text-prompt animation. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Hydra (3 credits/s, shortest duration 3s, so 9 credits minimum; 3s = 9, 3.5s = 10.5, 4s = 12, 4.5s = 13.5, 5s = 15) · Hydra+ (4 credits/s, shortest duration 3s, so 12 credits minimum; 3s = 12, 3.5s = 14, 4s = 16, 4.5s = 18, 5s = 20) · Forge (1.5 credits/s; 1s = 1.5, 1.5s = 2.3, 2s = 3, 2.5s = 3.8, 3s = 4.5, 3.5s = 5.3, 4s = 6, 4.5s = 6.8, 5s = 7.5) · Forge Pixel (1.5 credits/s; 1s = 1.5, 1.5s = 2.3, 2s = 3, 2.5s = 3.8, 3s = 4.5, 3.5s = 5.3, 4s = 6, 4.5s = 6.8, 5s = 7.5).", "x-mcp-description": "Animate a sprite through up to three fixed keyframes - initial_image, middle_image and final_image (each a URL or base64) - producing a spritesheet that interpolates through the provided frames in order. At least one of initial_image or middle_image is required (a final_image alone has nothing to anchor the animation); any keyframe may be omitted. The motion_prompt is optional here - when omitted, the motion is derived purely from the keyframes. Runs on hydra (default; also returns `audio_url`), hydra-plus (hydra with finer detail, also returns `audio_url`), forge, or forge-pixel for pixel-art sprites - the models that support a middle keyframe; any other model returns HTTP 400. For just a start and end frame, animateSprite with `final_image` does the same job. The job result is the same sprite result as animateSprite (`spritesheet_url`, `video_url`, grid fields, optional GIF and frame URLs, `audio_url` on hydra and hydra-plus). Credits are held for the duration you requested when the job is accepted; the final charge is rate × seconds of video generated, never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. The returned sheet is then trimmed to its best loop and can run slightly shorter than the video; that trim is not deducted. Use animateSprite instead for the classic single-image + text-prompt animation. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: credits/s × seconds, per model: Hydra 3/s (shortest duration 3s, so 9 credits minimum), Hydra+ 4/s (shortest duration 3s, so 12 credits minimum), Forge 1.5/s, Forge Pixel 1.5/s; see this endpoint's full pricing table in the API docs." } }, "/assets/sprite/pose": { "post": { "summary": "generatePose", "tags": [ "Spritesheets" ], "operationId": "generatePose", "x-credit-action": "GENERATE_IMAGE", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratePosePayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PoseResult" } } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/pose\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"image\":\" OR data:image/png;base64,...\",\"pose\":\"Idle (Front)\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/pose\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"image\": \" OR data:image/png;base64,...\",\n \"pose\": \"Idle (Front)\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/pose\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"image\": \" OR data:image/png;base64,...\",\n \"pose\": \"Idle (Front)\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 0.5 credits per result", "x-credit-summary": "This endpoint consumes 0.5 credits per result", "description": "Re-pose an existing sprite into a new target pose while preserving the character, taking a source image (URL or base64), a pose name (or \"Other\" with a free-text description), and an optional n (1-4) for how many variations to produce. Only works with sprite image types (not icons, screenshots, etc.). The job result is an array of pose results, each containing the generated image url, the pose and description used, and a suggested motion_prompt tuned for that pose. Credits are held when the job is accepted and refunded if it fails or is cancelled; the charge scales with the number of images generated. This is typically the first step before animating: call generatePose to set the character's pose, then feed the result (and its suggested motion_prompt) into animateSprite for the best animation quality; use rotateSprite instead when you want to change the camera angle rather than the pose. Pass an optional request_id to tag the results so you can locate them later via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 0.5 credits per result.", "x-mcp-description": "Re-pose an existing sprite into a new target pose while preserving the character, taking a source image (URL or base64), a pose name (or \"Other\" with a free-text description), and an optional n (1-4) for how many variations to produce. Only works with sprite image types (not icons, screenshots, etc.). The job result is an array of pose results, each containing the generated image url, the pose and description used, and a suggested motion_prompt tuned for that pose. Credits are held when the job is accepted and refunded if it fails or is cancelled; the charge scales with the number of images generated. This is typically the first step before animating: call generatePose to set the character's pose, then feed the result (and its suggested motion_prompt) into animateSprite for the best animation quality; use rotateSprite instead when you want to change the camera angle rather than the pose. Pass an optional request_id to tag the results so you can locate them later via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 0.5 credits per result." } }, "/assets/sprite/rotate": { "post": { "summary": "rotateSprite", "tags": [ "Spritesheets" ], "operationId": "rotateSprite", "x-credit-action": "GENERATE_IMAGE", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateSpritePayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RotateSpriteResult" } } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/rotate\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"image\":\" OR data:image/png;base64,...\",\"camera_rotation\":0}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/rotate\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"image\": \" OR data:image/png;base64,...\",\n \"camera_rotation\": 0\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/rotate\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"image\": \" OR data:image/png;base64,...\",\n \"camera_rotation\": 0\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 0.5 credits per result", "x-credit-summary": "This endpoint consumes 0.5 credits per result", "description": "Re-render an existing sprite from a different camera viewpoint while keeping the same character and pose, taking a source image (URL or base64), a required camera_rotation azimuth (one of 0, 45, 90, 135, 180, -135, -90, -45 degrees), an optional camera_elevation (0, 30, or 60 degrees; omit to keep the current elevation), and an optional n (1-4) for the number of variations. Only works with sprite image types (not icons, screenshots, etc.). The job result is an array of rotate-sprite results, each with the generated image url and the camera_rotation and camera_elevation that were applied. Credits are held when the job is accepted and refunded if it fails or is cancelled; the charge scales with the number of images generated. Use this to produce alternate view angles of a character; use generatePose instead to change the character's pose rather than the camera, and animateSprite or transferMotion to bring a sprite to life. Pass an optional request_id to tag the results so you can retrieve them later via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 0.5 credits per result.", "x-mcp-description": "Re-render an existing sprite from a different camera viewpoint while keeping the same character and pose, taking a source image (URL or base64), a required camera_rotation azimuth (one of 0, 45, 90, 135, 180, -135, -90, -45 degrees), an optional camera_elevation (0, 30, or 60 degrees; omit to keep the current elevation), and an optional n (1-4) for the number of variations. Only works with sprite image types (not icons, screenshots, etc.). The job result is an array of rotate-sprite results, each with the generated image url and the camera_rotation and camera_elevation that were applied. Credits are held when the job is accepted and refunded if it fails or is cancelled; the charge scales with the number of images generated. Use this to produce alternate view angles of a character; use generatePose instead to change the character's pose rather than the camera, and animateSprite or transferMotion to bring a sprite to life. Pass an optional request_id to tag the results so you can retrieve them later via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 0.5 credits per result." } }, "/assets/sprite/transfer-motion": { "post": { "summary": "transferMotion", "tags": [ "Spritesheets" ], "operationId": "transferMotion", "x-credit-action": "TRANSFER_SPRITE_MOTION", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferMotionPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpriteResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/transfer-motion\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"image\":\" OR data:image/png;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/transfer-motion\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"image\": \" OR data:image/png;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/transfer-motion\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"image\": \" OR data:image/png;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Hydra (3 credits/s; 3s = 9, 3.5s = 10.5, 4s = 12, 4.5s = 13.5, 5s = 15) · Forge (2 credits/s; 1s = 2, 1.5s = 3, 2s = 4, 2.5s = 5, 3s = 6, 3.5s = 7, 4s = 8, 4.5s = 9, 5s = 10) · Forge Pixel (2 credits/s; 1s = 2, 1.5s = 3, 2s = 4, 2.5s = 5, 3s = 6, 3.5s = 7, 4s = 8, 4.5s = 9, 5s = 10) · Tango (4 credits/s, minimum charge 4 credits per generation; 1s = 4, 1.5s = 6, 2s = 8, 2.5s = 10, 3s = 12, 3.5s = 14, 4s = 16) - LEGACY - scheduled for removal, do not use for new work", "x-credit-summary": "credits/s × seconds, per model: Hydra 3/s, Forge 2/s, Forge Pixel 2/s, Tango 4/s (min charge 4 credits) [LEGACY]; [LEGACY] models are scheduled for removal - do not use them for new work; see this endpoint's full pricing table in the API docs", "description": "Transfer motion from a reference video or a named animation preset onto a static sprite image, producing an animated spritesheet that mimics the reference movement. Provide the sprite as image (URL or base64) plus either a video URL or a preset_id together with perspective and direction (all three from listAnimationPresets; if both video and preset_id are sent the video wins). The job result is the same sprite result as animateSprite: `spritesheet_url`, `video_url`, grid fields, optional GIF / frame / with-background URLs, and `audio_url` when the model is hydra. `duration` defaults to 1.5s where the chosen model offers it, otherwise to that model's shortest (hydra, the default, starts at 3s) - and a longer reference clip or preset is compressed to fit, so pass the preset's own `duration` (returned by listAnimationPresets) to keep its timing. It returns HTTP 400 if neither a video nor a complete preset_id/perspective/direction triple is supplied, if the named preset, perspective, or direction cannot be resolved, or if the model/duration combination is invalid. Credits are held for the duration you requested when the job is accepted; the final charge is rate × seconds of video generated (which follows the reference clip or preset; legacy models keep their minimum charge), never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. The returned sheet is then trimmed to its best loop and can run slightly shorter than the video; that trim is not deducted. Use this when you have an existing motion clip or preset to copy; prefer animateSprite to generate animation purely from a text prompt. Omit `model` to run on hydra (the default - most capable, and returns audio); pick forge for a cheaper run on simple motion, presets and matching poses; the `model` field lists rates. Pass an optional request_id to tag the result so you can retrieve it later via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Hydra (3 credits/s; 3s = 9, 3.5s = 10.5, 4s = 12, 4.5s = 13.5, 5s = 15) · Forge (2 credits/s; 1s = 2, 1.5s = 3, 2s = 4, 2.5s = 5, 3s = 6, 3.5s = 7, 4s = 8, 4.5s = 9, 5s = 10) · Forge Pixel (2 credits/s; 1s = 2, 1.5s = 3, 2s = 4, 2.5s = 5, 3s = 6, 3.5s = 7, 4s = 8, 4.5s = 9, 5s = 10) · Tango (4 credits/s, minimum charge 4 credits per generation; 1s = 4, 1.5s = 6, 2s = 8, 2.5s = 10, 3s = 12, 3.5s = 14, 4s = 16) - LEGACY - scheduled for removal, do not use for new work.", "x-mcp-description": "Transfer motion from a reference video or a named animation preset onto a static sprite image, producing an animated spritesheet that mimics the reference movement. Provide the sprite as image (URL or base64) plus either a video URL or a preset_id together with perspective and direction (all three from listAnimationPresets; if both video and preset_id are sent the video wins). The job result is the same sprite result as animateSprite: `spritesheet_url`, `video_url`, grid fields, optional GIF / frame / with-background URLs, and `audio_url` when the model is hydra. `duration` defaults to 1.5s where the chosen model offers it, otherwise to that model's shortest (hydra, the default, starts at 3s) - and a longer reference clip or preset is compressed to fit, so pass the preset's own `duration` (returned by listAnimationPresets) to keep its timing. It returns HTTP 400 if neither a video nor a complete preset_id/perspective/direction triple is supplied, if the named preset, perspective, or direction cannot be resolved, or if the model/duration combination is invalid. Credits are held for the duration you requested when the job is accepted; the final charge is rate × seconds of video generated (which follows the reference clip or preset; legacy models keep their minimum charge), never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. The returned sheet is then trimmed to its best loop and can run slightly shorter than the video; that trim is not deducted. Use this when you have an existing motion clip or preset to copy; prefer animateSprite to generate animation purely from a text prompt. Omit `model` to run on hydra (the default - most capable, and returns audio); pick forge for a cheaper run on simple motion, presets and matching poses; the `model` field lists rates. Pass an optional request_id to tag the result so you can retrieve it later via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: credits/s × seconds, per model: Hydra 3/s, Forge 2/s, Forge Pixel 2/s, Tango 4/s (min charge 4 credits) [LEGACY]; [LEGACY] models are scheduled for removal - do not use them for new work; see this endpoint's full pricing table in the API docs." } }, "/docs": { "get": { "description": "Browse or read Ludo's own documentation in full - how to choose a sprite animation mode, when to use Generate Before / Generate After, how margins behave, which model suits a job, and each generator's known limitations. To answer a specific question, call searchDocs first: it returns just the sections that match. Use getDocs to see what documentation exists, or to read a whole document or named sections. This is the same documentation the Ludo web app shows its users, so it occasionally describes buttons rather than parameters; the substance applies to the API and MCP surfaces just the same. To browse, call it with NO parameters to get a table of contents - every document with its id, label and section titles, and no bodies - then call it again with `doc` (and optionally `sections`) to read only what you need. Fetching a whole document can return tens of thousands of characters, so prefer naming the sections, using titles copied from the table of contents. Section titles match ignoring case, spacing and punctuation: when only some requested titles exist you receive those sections plus `unmatched_sections` and `available_sections`, and when none exist (or `doc` is unknown) the call returns 400 listing the valid values so you can retry once. This is a free discovery endpoint: it does not charge credits and does not queue a job. Requires an API key (user scope).", "tags": [ "Documentation" ], "operationId": "getDocs", "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "doc", "in": "query", "description": "Which document to read, by id (the table of contents returned by the no-parameter call lists them). Omit to receive the table of contents.", "required": false, "schema": { "type": "string", "enum": [ "assistant", "game-ideator", "image-generator", "project", "account", "faq", "3d-generator", "video-generator", "sprite-generator", "audio-generator", "api-mcp", "game-asset-generation", "directional-sprites" ] } }, { "name": "sections", "in": "query", "description": "Section titles to return from `doc`, copied from the table of contents (an array of titles; over plain REST, a comma-separated string, where a title that itself contains a comma is still matched whole). Matching ignores case, spacing and punctuation; titles that match nothing are reported back in `unmatched_sections` rather than guessed at. Only valid together with `doc`. Omit to return every section of the document.", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentationResponse" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Documentation temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/docs\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/docs\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/docs\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/docs/search": { "get": { "description": "Search Ludo's own documentation with a plain-language question and get back only the few sections that answer it - the fastest way to learn how a feature is meant to be used before you generate with it (how to pick a sprite animation mode or model, how margins behave, what something costs, known limitations). Start here rather than reading whole documents. Each result carries `doc` and `section`, which you can pass straight to getDocs to re-read that section, and the section's full markdown `content`. Results are best first; weak matches are left out, so an empty `results` list means the documentation does not cover the question - rephrase it, or call getDocs with no parameters to browse the table of contents. This is the same documentation the Ludo web app shows its users, so it occasionally describes buttons rather than parameters; the substance applies to the API and MCP surfaces just the same. Returns up to `n` sections (default 3, max 10). If it answers 503 the search backend is briefly unavailable: call getDocs instead rather than retrying in a loop. This is a free discovery endpoint: it does not charge credits and does not queue a job. Requires an API key (user scope).", "tags": [ "Documentation" ], "operationId": "searchDocs", "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "query", "in": "query", "description": "What you want to know, in plain language, e.g. \"how do I keep a sprite animation's colors consistent\" or \"what does a 3D model cost\".", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "n", "in": "query", "description": "Maximum number of sections to return. Defaults to 3.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 10 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentationSearchResponse" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Documentation search temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/docs/search\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/docs/search\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/docs/search\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/sprite/animation-presets": { "get": { "description": "List the available animation presets along with their perspectives and the eight supported compass directions (N, NE, E, SE, S, SW, W, NW). Synchronous GET with no request body: it returns an animations array (each with id, name, category, description, duration, and preview_url), a deduplicated perspectives array, and the directions list. This is a free discovery endpoint and does not charge credits. Use it to obtain the preset_id, perspective, and direction values that transferMotion needs, and to find motion preset names you can reference when animating; pair it with transferMotion (to apply a preset onto a sprite), animateSprite (text-prompt animation), or animate3DModelPreset (apply any preset by id to a rigged 3D model). Requires an API key (user scope).", "tags": [ "Spritesheets" ], "operationId": "listAnimationPresets", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnimationPresetsResponse" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/sprite/animation-presets\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/animation-presets\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/sprite/animation-presets\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/sprite/edit": { "post": { "summary": "editSpritesheet", "tags": [ "Spritesheets" ], "operationId": "editSpritesheet", "x-credit-action": "EDIT_SPRITESHEET", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditSpritesheetPayloadPublic" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpriteResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/edit\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"spritesheet_url\":\"\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/edit\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"spritesheet_url\": \"\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/edit\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"spritesheet_url\": \"\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Hydra (3 credits/s; 3s = 9, 3.5s = 10.5, 4s = 12, 4.5s = 13.5, 5s = 15) · Forge (2 credits/s; 1s = 2, 1.5s = 3, 2s = 4, 2.5s = 5, 3s = 6, 3.5s = 7, 4s = 8, 4.5s = 9, 5s = 10) · Forge Pixel (2 credits/s; 1s = 2, 1.5s = 3, 2s = 4, 2.5s = 5, 3s = 6, 3.5s = 7, 4s = 8, 4.5s = 9, 5s = 10). edit_mode \"fix_loop\" / \"outpaint\": flat 1 credit per second of output, capped at the source spritesheet's video length, no minimum, model ignored; edit_mode \"improve\" (hydra spritesheets only): flat 1 credit per second of output, same terms; edit_mode \"prompt\": per model as listed", "x-credit-summary": "edit_mode \"fix_loop\" / \"outpaint\": flat 1 credit per second of output, capped at the source spritesheet's video length, no minimum, model ignored; edit_mode \"improve\" (hydra spritesheets only): flat 1 credit per second of output, same terms; edit_mode \"prompt\": per model as listed - credits/s × seconds, per model: Hydra 3/s, Forge 2/s, Forge Pixel 2/s; see this endpoint's full pricing table in the API docs", "description": "Edit a previously generated spritesheet: re-prompt its underlying animation (edit_mode \"prompt\"), extend the frame beyond its borders (\"outpaint\"), repair a bad loop (\"fix_loop\"), or re-render it with finer detail (\"improve\": the extra pass hydra-plus runs when it generates, on a spritesheet generated with hydra only - any other returns HTTP 400; a sheet generated on hydra-plus already has it). Pass the `spritesheet_url` you received from `animateSprite`, `animateSpriteKeyframes`, `transferMotion`, or an earlier edit - it must be a spritesheet you generated within the last 7 days; arbitrary external images are not accepted. Omit `duration`, `frames`, `frame_size`, `crop` and `model` to keep the source spritesheet's values. A `prompt` is required for edit_mode \"prompt\", optional for \"outpaint\", and not accepted for \"fix_loop\" or \"improve\"; optionally add up to 5 reference `images` (URL or base64) to guide the edit. The job result is the same result shape as animateSprite (spritesheet URL, frame layout, optional GIF or individual frames). Credits are held when the job is accepted; the final charge is rate × seconds of video generated, never more than was held, and the difference (or everything, if the job fails or is cancelled) is refunded. The returned sheet is then trimmed to its best loop and can run slightly shorter than the video; that trim is not deducted. Prompt edits are priced per model (credits/second × duration) and held for the duration you requested; \"outpaint\", \"fix_loop\" and \"improve\" run a lighter pipeline in which `model` is ignored and are billed at a flat 1 credit per second of output, held for and capped at the length of the source spritesheet's video (`duration` does not change their price). Outpaint decides the extra margin itself - there is no amount parameter. The result carries the same fields as animateSprite (`spritesheet_url`, `video_url`, grid fields); new audio is generated only by prompt edits on hydra: \"fix_loop\", \"outpaint\" and \"improve\" do not regenerate it, and their result carries the source spritesheet's `audio_url` when it had one. Pass an optional `request_id` to tag the result for later retrieval via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Hydra (3 credits/s; 3s = 9, 3.5s = 10.5, 4s = 12, 4.5s = 13.5, 5s = 15) · Forge (2 credits/s; 1s = 2, 1.5s = 3, 2s = 4, 2.5s = 5, 3s = 6, 3.5s = 7, 4s = 8, 4.5s = 9, 5s = 10) · Forge Pixel (2 credits/s; 1s = 2, 1.5s = 3, 2s = 4, 2.5s = 5, 3s = 6, 3.5s = 7, 4s = 8, 4.5s = 9, 5s = 10). edit_mode \"fix_loop\" / \"outpaint\": flat 1 credit per second of output, capped at the source spritesheet's video length, no minimum, model ignored; edit_mode \"improve\" (hydra spritesheets only): flat 1 credit per second of output, same terms; edit_mode \"prompt\": per model as listed.", "x-mcp-description": "Edit a previously generated spritesheet: re-prompt its underlying animation (edit_mode \"prompt\"), extend the frame beyond its borders (\"outpaint\"), repair a bad loop (\"fix_loop\"), or re-render it with finer detail (\"improve\": the extra pass hydra-plus runs when it generates, on a spritesheet generated with hydra only - any other returns HTTP 400; a sheet generated on hydra-plus already has it). Pass the `spritesheet_url` you received from `animateSprite`, `animateSpriteKeyframes`, `transferMotion`, or an earlier edit - it must be a spritesheet you generated within the last 7 days; arbitrary external images are not accepted. Omit `duration`, `frames`, `frame_size`, `crop` and `model` to keep the source spritesheet's values. A `prompt` is required for edit_mode \"prompt\", optional for \"outpaint\", and not accepted for \"fix_loop\" or \"improve\"; optionally add up to 5 reference `images` (URL or base64) to guide the edit. The job result is the same result shape as animateSprite (spritesheet URL, frame layout, optional GIF or individual frames). Credits are held when the job is accepted; the final charge is rate × seconds of video generated, never more than was held, and the difference (or everything, if the job fails or is cancelled) is refunded. The returned sheet is then trimmed to its best loop and can run slightly shorter than the video; that trim is not deducted. Prompt edits are priced per model (credits/second × duration) and held for the duration you requested; \"outpaint\", \"fix_loop\" and \"improve\" run a lighter pipeline in which `model` is ignored and are billed at a flat 1 credit per second of output, held for and capped at the length of the source spritesheet's video (`duration` does not change their price). Outpaint decides the extra margin itself - there is no amount parameter. The result carries the same fields as animateSprite (`spritesheet_url`, `video_url`, grid fields); new audio is generated only by prompt edits on hydra: \"fix_loop\", \"outpaint\" and \"improve\" do not regenerate it, and their result carries the source spritesheet's `audio_url` when it had one. Pass an optional `request_id` to tag the result for later retrieval via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: edit_mode \"fix_loop\" / \"outpaint\": flat 1 credit per second of output, capped at the source spritesheet's video length, no minimum, model ignored; edit_mode \"improve\" (hydra spritesheets only): flat 1 credit per second of output, same terms; edit_mode \"prompt\": per model as listed - credits/s × seconds, per model: Hydra 3/s, Forge 2/s, Forge Pixel 2/s; see this endpoint's full pricing table in the API docs." } }, "/assets/sprite/rotate-spritesheet": { "post": { "summary": "rotateSpritesheet", "tags": [ "Spritesheets" ], "operationId": "rotateSpritesheet", "x-cli-name": "rotate-sheet", "x-credit-action": "NEW_VIEW_SPRITESHEET", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateSpritesheetPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpriteResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/rotate-spritesheet\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"spritesheet_url\":\"\",\"image\":\" OR data:image/png;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/rotate-spritesheet\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"spritesheet_url\": \"\",\n \"image\": \" OR data:image/png;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/rotate-spritesheet\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"spritesheet_url\": \"\",\n \"image\": \" OR data:image/png;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "Cost varies by model and duration (credits/second × duration)", "x-credit-summary": "Cost varies by model and duration (credits/second × duration)", "description": "Re-render a previously generated sprite animation from a new view: the same motion and timing, seen from a different angle (e.g. a front-facing walk cycle turned into the same walk seen from the back). Pass the `spritesheet_url` you received from `animateSprite`, `animateSpriteKeyframes`, `transferMotion`, `editSpritesheet` or an earlier call - it must be a spritesheet you generated within the last 7 days; arbitrary external images are not accepted - and, as `image` (URL or base64), the character exactly as it must appear in the new view: it becomes the first frame of the animation. To produce that image, call rotateSprite on the animation's first frame (or any image of the character) and pick the view you want. An optional `final_image` fixes the last frame (it defaults to the first frame, for cyclic or returning animations), and an optional `prompt` steers the result: the character's facing in the new view (\"its back to the camera\"), where the action goes (\"the kick goes to the left of the frame\"), or anything else about the motion. Runs on hydra (default) or hydra-plus (finer detail). The job result is the same sprite result as animateSprite (`spritesheet_url`, `video_url`, grid fields, optional GIF and frame URLs). The animation covers the source's own length (up to 5 seconds; a longer source is sped up to fit), so omit `duration` unless you need to change that. Credits are held for that length when the job is accepted, or for 3 seconds when it is shorter (a new view is a new generation, and hydra generates at least 3 seconds); the final charge is the model's rate × seconds of video generated, never more than was held, and the difference (or everything, if the job fails or is cancelled) is refunded. Pass an optional request_id to tag the result for later retrieval via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** Cost varies by model and duration (credits/second × duration).", "x-mcp-description": "Re-render a previously generated sprite animation from a new view: the same motion and timing, seen from a different angle (e.g. a front-facing walk cycle turned into the same walk seen from the back). Pass the `spritesheet_url` you received from `animateSprite`, `animateSpriteKeyframes`, `transferMotion`, `editSpritesheet` or an earlier call - it must be a spritesheet you generated within the last 7 days; arbitrary external images are not accepted - and, as `image` (URL or base64), the character exactly as it must appear in the new view: it becomes the first frame of the animation. To produce that image, call rotateSprite on the animation's first frame (or any image of the character) and pick the view you want. An optional `final_image` fixes the last frame (it defaults to the first frame, for cyclic or returning animations), and an optional `prompt` steers the result: the character's facing in the new view (\"its back to the camera\"), where the action goes (\"the kick goes to the left of the frame\"), or anything else about the motion. Runs on hydra (default) or hydra-plus (finer detail). The job result is the same sprite result as animateSprite (`spritesheet_url`, `video_url`, grid fields, optional GIF and frame URLs). The animation covers the source's own length (up to 5 seconds; a longer source is sped up to fit), so omit `duration` unless you need to change that. Credits are held for that length when the job is accepted, or for 3 seconds when it is shorter (a new view is a new generation, and hydra generates at least 3 seconds); the final charge is the model's rate × seconds of video generated, never more than was held, and the difference (or everything, if the job fails or is cancelled) is refunded. Pass an optional request_id to tag the result for later retrieval via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: Cost varies by model and duration (credits/second × duration)." } }, "/assets/sprite/adjust": { "post": { "summary": "Adjust Sprite Sheet: re-export a previously generated sprite animation with different sheet settings - frame count, frame size, loop trimming or whitespace cropping - without generating the animation again. Free (no credits). Pass the `spritesheet_url` you received from `animateSprite`, `animateSpriteKeyframes`, `transferMotion`, `editSpritesheet`, `rotateSpritesheet` or an earlier adjust - it must be a spritesheet you generated through the API within the last 7 days; arbitrary external images are not accepted. Omit a setting to keep the source's value. The animation itself is unchanged: this only re-cuts the same video into a new sheet, so use it to fix framing (for example an effect clipped by True Size: re-export with a fixed `frame_size` or 0), to change the frame count or size for your engine, to upscale it 1.5x (`frame_size` -1), or to turn loop trimming on or off. It cannot change the motion, margins or content - use editSpritesheet for that. The source is left as it is and the result is a new spritesheet with its own `spritesheet_url`. The job result is the same sprite result as animateSprite (`spritesheet_url`, `video_url`, grid fields, optional GIF and frame URLs, and the source's `audio_url` when it has one). Limited to 20 calls per 5 minutes, 120 an hour and 1000 a day. Pass an optional request_id to tag the result for later retrieval via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).", "tags": [ "Spritesheets" ], "operationId": "adjustSpritesheet", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustSpritesheetPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpriteResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/adjust\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"spritesheet_url\":\"\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/adjust\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"spritesheet_url\": \"\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/adjust\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"spritesheet_url\": \"\"\n }\n)\n\nprint(response.json())" } ] } }, "/assets/sprite/audio": { "post": { "summary": "createSpriteAudio", "tags": [ "Spritesheets" ], "operationId": "createSpriteAudio", "x-credit-action": "GENERATE_AUDIO_FOR_SPRITES", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpriteAudioPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/audio\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"spritesheet_video_url\":\"\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/audio\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"spritesheet_video_url\": \"\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/audio\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"spritesheet_video_url\": \"\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 3 credits per call", "x-credit-summary": "This endpoint consumes 3 credits per call", "description": "Generate a sound effect for a previously generated spritesheet animation. Pass, as `spritesheet_video_url`, the `video_url` you received from `animateSprite`, `animateSpriteKeyframes`, `transferMotion`, or `editSpritesheet` - it must belong to a spritesheet you generated within the last 7 days; arbitrary external videos are not accepted. Spritesheets generated with the hydra model already come with `audio_url`, so only call this for forge / forge-pixel output or to replace hydra's sound. Optionally add a `prompt` describing the sound you want. The job result is only the URL of the generated audio file, an MP3 or WAV (the URL's extension, .mp3 or .wav, says which); no video is returned. The audio is also attached to the spritesheet, so it appears as `audio_url` in listGenerations (type spritesheet), where the spritesheet keeps the `request_id` it was generated with. Pass an optional `request_id` to make this call idempotent and to find its job again; it must not be one you already used for another generation. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 3 credits per call.", "x-mcp-description": "Generate a sound effect for a previously generated spritesheet animation. Pass, as `spritesheet_video_url`, the `video_url` you received from `animateSprite`, `animateSpriteKeyframes`, `transferMotion`, or `editSpritesheet` - it must belong to a spritesheet you generated within the last 7 days; arbitrary external videos are not accepted. Spritesheets generated with the hydra model already come with `audio_url`, so only call this for forge / forge-pixel output or to replace hydra's sound. Optionally add a `prompt` describing the sound you want. The job result is only the URL of the generated audio file, an MP3 or WAV (the URL's extension, .mp3 or .wav, says which); no video is returned. The audio is also attached to the spritesheet, so it appears as `audio_url` in listGenerations (type spritesheet), where the spritesheet keeps the `request_id` it was generated with. Pass an optional `request_id` to make this call idempotent and to find its job again; it must not be one you already used for another generation. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 3 credits per call." } }, "/assets/sprite/directional-styles": { "get": { "description": "List the styles Directional Sprites can render a 3D model in, with the perspectives (camera heights) and the eight directions they render from. Each style has an id (pass it as style_id), a label, a description, a family, whether it is pixel art, a thumbnail_url of the style at its defaults, its current version, and its settings: each setting has a name (the key in style_params), a kind (choice, bool or color - a color setting also takes any colour), its options ({label, value}) and its default. advanced_settings work the same way. Free discovery endpoint: it does not charge credits. Use it before previewDirectionalSprites, createDirectionalSprites and createDirectionalStills. Requires an API key (user scope).", "tags": [ "Spritesheets" ], "operationId": "listDirectionalSpriteStyles", "x-cli-name": "directional-styles", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectionalSpriteStylesResponse" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/sprite/directional-styles\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/directional-styles\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/sprite/directional-styles\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/sprite/directional-preview": { "post": { "summary": "Preview Directional Sprites: a few frames of a 3D model in a style, from each direction asked for, to check a style before rendering. Takes the same model, animation, camera and style fields as createDirectionalSprites. The response (synchronous, not a job) has one preview per direction, in the order asked, each with `frame_urls` - the frames as images (4 for an animated model, 1 for a still one) - and `render_3d`, the style and settings as rendered, which createDirectionalSprites takes back as they are. Free (no credits), and nothing is saved to your generations; the frame images are kept for 7 days. A preview takes several seconds. You run one preview at a time: starting another while one is still running cancels the older one, which then answers 204 with no body. Preview one or two directions while trying styles and render only once the look is right. Requires an API key (user scope).", "tags": [ "Spritesheets" ], "operationId": "previewDirectionalSprites", "x-cli-name": "directional-preview", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectionalPreviewPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectionalPreviewResult" } } } }, "204": { "description": "Cancelled by a newer preview of yours" }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Previews temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/directional-preview\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"model\":\" OR data:model/gltf-binary;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/directional-preview\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"model\": \" OR data:model/gltf-binary;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/directional-preview\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"model\": \" OR data:model/gltf-binary;base64,...\"\n }\n)\n\nprint(response.json())" } ] } }, "/assets/sprite/directional": { "post": { "summary": "createDirectionalSprites", "tags": [ "Spritesheets" ], "operationId": "createDirectionalSprites", "x-cli-name": "directional", "x-credit-action": "RENDER_SPRITE_3D", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectionalSpritesPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectionalSpritesResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/directional\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"model\":\" OR data:model/gltf-binary;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/directional\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"model\": \" OR data:model/gltf-binary;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/directional\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"model\": \" OR data:model/gltf-binary;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 1 credit per direction (one sheet each)", "x-credit-summary": "This endpoint consumes 1 credit per direction (one sheet each)", "description": "Directional Sprites: render a 3D model into one spritesheet per direction, in a style. Pass the GLB in `model` (URL or base64; rigged, to animate it - see create3DModel with rig, or rigModel) and at most one animation: `animation_url` (the `glb_url` of an animation from animate3DModel or animate3DModelPreset, made for this model), `preset_id` (a preset from listAnimationPresets, retargeted onto the model; any rig type can take one, though retargeting does not succeed on every model, and when it does not the call returns an error) or `model_animation` (the name of an animation the GLB itself carries). With no animation each sheet is a single frame. `directions` are where the camera stands around a character facing S (up to 8); every direction is rendered together, on the same frame size, scale and floor, so the sheets line up. Pick the style with listDirectionalSpriteStyles (style_id, and style_params for its settings) and check it with previewDirectionalSprites first. The job result is one sheet per direction, in the order asked, each with its `spritesheet_url`, grid fields, fps and `render_3d`. Credits are held for every direction when the job is accepted and charged for the sheets that come back; a failed or cancelled job is refunded. Pass an optional request_id to tag the sheets for later retrieval via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 1 credit per direction (one sheet each).", "x-mcp-description": "Directional Sprites: render a 3D model into one spritesheet per direction, in a style. Pass the GLB in `model` (URL or base64; rigged, to animate it - see create3DModel with rig, or rigModel) and at most one animation: `animation_url` (the `glb_url` of an animation from animate3DModel or animate3DModelPreset, made for this model), `preset_id` (a preset from listAnimationPresets, retargeted onto the model; any rig type can take one, though retargeting does not succeed on every model, and when it does not the call returns an error) or `model_animation` (the name of an animation the GLB itself carries). With no animation each sheet is a single frame. `directions` are where the camera stands around a character facing S (up to 8); every direction is rendered together, on the same frame size, scale and floor, so the sheets line up. Pick the style with listDirectionalSpriteStyles (style_id, and style_params for its settings) and check it with previewDirectionalSprites first. The job result is one sheet per direction, in the order asked, each with its `spritesheet_url`, grid fields, fps and `render_3d`. Credits are held for every direction when the job is accepted and charged for the sheets that come back; a failed or cancelled job is refunded. Pass an optional request_id to tag the sheets for later retrieval via listGenerations (type spritesheet). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 1 credit per direction (one sheet each)." } }, "/assets/sprite/directional-stills": { "post": { "summary": "createDirectionalStills", "tags": [ "Spritesheets" ], "operationId": "createDirectionalStills", "x-cli-name": "directional-stills", "x-credit-action": "RENDER_SPRITE_3D_STILL", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectionalStillsPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectionalStillsResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/sprite/directional-stills\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"model\":\" OR data:model/gltf-binary;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprite/directional-stills\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"model\": \" OR data:model/gltf-binary;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/sprite/directional-stills\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"model\": \" OR data:model/gltf-binary;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 0.5 credits per direction (one image each)", "x-credit-summary": "This endpoint consumes 0.5 credits per direction (one image each)", "description": "Directional Sprites stills: render a 3D model as it is (no animation) into one large image per direction, in a style, on a transparent background. Pass the GLB in `model` (URL or base64), the `directions` (up to 8, rendered together so they line up) and the style (listDirectionalSpriteStyles). Each still is a sprite image you can animate with animateSprite or edit with editImage. The job result is one image per direction, in the order asked. Credits are held for every direction when the job is accepted and charged for the images that come back; a failed or cancelled job is refunded. Pass an optional request_id to tag the images for later retrieval via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 0.5 credits per direction (one image each).", "x-mcp-description": "Directional Sprites stills: render a 3D model as it is (no animation) into one large image per direction, in a style, on a transparent background. Pass the GLB in `model` (URL or base64), the `directions` (up to 8, rendered together so they line up) and the style (listDirectionalSpriteStyles). Each still is a sprite image you can animate with animateSprite or edit with editImage. The job result is one image per direction, in the order asked. Credits are held for every direction when the job is accepted and charged for the images that come back; a failed or cancelled job is refunded. Pass an optional request_id to tag the images for later retrieval via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 0.5 credits per direction (one image each)." } }, "/assets/video": { "post": { "summary": "createVideo", "tags": [ "Videos" ], "operationId": "createVideo", "x-credit-action": "GENERATE_VIDEO", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateVideoPayloadPublic" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/video\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"image\":\" OR data:image/png;base64,...\",\"prompt\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/video\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"image\": \" OR data:image/png;base64,...\",\n \"prompt\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/video\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"image\": \" OR data:image/png;base64,...\",\n \"prompt\": \"string\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Griffin (1.5 credits/s, shortest duration 5s, so 7.5 credits minimum; 5s = 7.5, 6s = 9, 7s = 10.5, 8s = 12, 9s = 13.5, 10s = 15, 11s = 16.5, 12s = 18, 13s = 19.5, 14s = 21, 15s = 22.5) · Griffin HD (2 credits/s, shortest duration 5s, so 10 credits minimum; 5s = 10, 6s = 12, 7s = 14, 8s = 16, 9s = 18, 10s = 20, 11s = 22, 12s = 24, 13s = 26, 14s = 28, 15s = 30) · Blitz (1 credits/s, shortest duration 2s, so 2 credits minimum; 2s = 2, 3s = 3, 4s = 4, 5s = 5, 6s = 6, 7s = 7, 8s = 8, 9s = 9, 10s = 10, 11s = 11, 12s = 12) - LEGACY - scheduled for removal, do not use for new work · Eagle (1.3 credits/s; 1s = 1.3, 2s = 2.6, 3s = 3.9, 4s = 5.2, 5s = 6.5, 6s = 7.8, 7s = 9.1, 8s = 10.4, 9s = 11.7, 10s = 13, 11s = 14.3, 12s = 15.6, 13s = 16.9, 14s = 18.2, 15s = 19.5) - LEGACY - scheduled for removal, do not use for new work · Eagle with Audio (1.8 credits/s; 1s = 1.8, 2s = 3.6, 3s = 5.4, 4s = 7.2, 5s = 9, 6s = 10.8, 7s = 12.6, 8s = 14.4, 9s = 16.2, 10s = 18, 11s = 19.8, 12s = 21.6, 13s = 23.4, 14s = 25.2, 15s = 27) - LEGACY - scheduled for removal, do not use for new work", "x-credit-summary": "credits/s × seconds, per model: Griffin 1.5/s (shortest duration 5s, so 7.5 credits minimum), Griffin HD 2/s (shortest duration 5s, so 10 credits minimum), Blitz 1/s (shortest duration 2s, so 2 credits minimum) [LEGACY], Eagle 1.3/s [LEGACY], Eagle with Audio 1.8/s [LEGACY]; [LEGACY] models are scheduled for removal - do not use them for new work; see this endpoint's full pricing table in the API docs", "description": "Generate a short video clip from a source image and a motion text prompt (image-to-video); a source `image` is required - to make a video from text alone, first createImage and animate that, or use createVideoFromReferences with reference images. Griffin (default, 480p) and Griffin HD (720p) both generate a soundtrack; no separate audio step is needed. The job result is the video URL and its actual duration in seconds. Optionally pass `final_image` to interpolate between a start and end frame. The chosen `model` and `duration` must be compatible (incompatible combinations return HTTP 400); see the `model` and `duration` fields for the values each model accepts. Credits are held when the job is accepted; the final charge is rate × produced seconds, never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. Pass an optional `request_id` to tag the result so you can locate it later via listGenerations (type video). Related tools: use `createImage` for static images, `animateSprite` for sprite-sheet animation, and listGenerations (type video) to list videos you generated earlier. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Griffin (1.5 credits/s, shortest duration 5s, so 7.5 credits minimum; 5s = 7.5, 6s = 9, 7s = 10.5, 8s = 12, 9s = 13.5, 10s = 15, 11s = 16.5, 12s = 18, 13s = 19.5, 14s = 21, 15s = 22.5) · Griffin HD (2 credits/s, shortest duration 5s, so 10 credits minimum; 5s = 10, 6s = 12, 7s = 14, 8s = 16, 9s = 18, 10s = 20, 11s = 22, 12s = 24, 13s = 26, 14s = 28, 15s = 30) · Blitz (1 credits/s, shortest duration 2s, so 2 credits minimum; 2s = 2, 3s = 3, 4s = 4, 5s = 5, 6s = 6, 7s = 7, 8s = 8, 9s = 9, 10s = 10, 11s = 11, 12s = 12) - LEGACY - scheduled for removal, do not use for new work · Eagle (1.3 credits/s; 1s = 1.3, 2s = 2.6, 3s = 3.9, 4s = 5.2, 5s = 6.5, 6s = 7.8, 7s = 9.1, 8s = 10.4, 9s = 11.7, 10s = 13, 11s = 14.3, 12s = 15.6, 13s = 16.9, 14s = 18.2, 15s = 19.5) - LEGACY - scheduled for removal, do not use for new work · Eagle with Audio (1.8 credits/s; 1s = 1.8, 2s = 3.6, 3s = 5.4, 4s = 7.2, 5s = 9, 6s = 10.8, 7s = 12.6, 8s = 14.4, 9s = 16.2, 10s = 18, 11s = 19.8, 12s = 21.6, 13s = 23.4, 14s = 25.2, 15s = 27) - LEGACY - scheduled for removal, do not use for new work.", "x-mcp-description": "Generate a short video clip from a source image and a motion text prompt (image-to-video); a source `image` is required - to make a video from text alone, first createImage and animate that, or use createVideoFromReferences with reference images. Griffin (default, 480p) and Griffin HD (720p) both generate a soundtrack; no separate audio step is needed. The job result is the video URL and its actual duration in seconds. Optionally pass `final_image` to interpolate between a start and end frame. The chosen `model` and `duration` must be compatible (incompatible combinations return HTTP 400); see the `model` and `duration` fields for the values each model accepts. Credits are held when the job is accepted; the final charge is rate × produced seconds, never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. Pass an optional `request_id` to tag the result so you can locate it later via listGenerations (type video). Related tools: use `createImage` for static images, `animateSprite` for sprite-sheet animation, and listGenerations (type video) to list videos you generated earlier. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: credits/s × seconds, per model: Griffin 1.5/s (shortest duration 5s, so 7.5 credits minimum), Griffin HD 2/s (shortest duration 5s, so 10 credits minimum), Blitz 1/s (shortest duration 2s, so 2 credits minimum) [LEGACY], Eagle 1.3/s [LEGACY], Eagle with Audio 1.8/s [LEGACY]; [LEGACY] models are scheduled for removal - do not use them for new work; see this endpoint's full pricing table in the API docs." } }, "/assets/video/references": { "post": { "summary": "createVideoFromReferences", "tags": [ "Videos" ], "operationId": "createVideoFromReferences", "x-credit-action": "REFERENCES_TO_VIDEO", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferencesToVideoPayloadPublic" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/video/references\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"prompt\":\"string\",\"images\":[\"string\"]}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/video/references\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"prompt\": \"string\",\n \"images\": [\n \"string\"\n ]\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/video/references\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"prompt\": \"string\",\n \"images\": [\n \"string\"\n ]\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Griffin (2.5 credits/s, shortest duration 5s, so 12.5 credits minimum; 5s = 12.5, 6s = 15, 7s = 17.5, 8s = 20, 9s = 22.5, 10s = 25, 11s = 27.5, 12s = 30, 13s = 32.5, 14s = 35, 15s = 37.5) · Griffin HD (4 credits/s, shortest duration 5s, so 20 credits minimum; 5s = 20, 6s = 24, 7s = 28, 8s = 32, 9s = 36, 10s = 40, 11s = 44, 12s = 48, 13s = 52, 14s = 56, 15s = 60) · Eagle (1.5 credits/s; 1s = 1.5, 2s = 3, 3s = 4.5, 4s = 6, 5s = 7.5, 6s = 9, 7s = 10.5, 8s = 12, 9s = 13.5, 10s = 15, 11s = 16.5, 12s = 18, 13s = 19.5, 14s = 21, 15s = 22.5) - LEGACY - scheduled for removal, do not use for new work · Eagle with Audio (2 credits/s; 1s = 2, 2s = 4, 3s = 6, 4s = 8, 5s = 10, 6s = 12, 7s = 14, 8s = 16, 9s = 18, 10s = 20, 11s = 22, 12s = 24, 13s = 26, 14s = 28, 15s = 30) - LEGACY - scheduled for removal, do not use for new work", "x-credit-summary": "credits/s × seconds, per model: Griffin 2.5/s (shortest duration 5s, so 12.5 credits minimum), Griffin HD 4/s (shortest duration 5s, so 20 credits minimum), Eagle 1.5/s [LEGACY], Eagle with Audio 2/s [LEGACY]; [LEGACY] models are scheduled for removal - do not use them for new work; see this endpoint's full pricing table in the API docs", "description": "Generate a video from 1-5 reference images and a text prompt (references-to-video). Unlike createVideo, which animates a single source image, this composes a new scene that borrows characters, objects, and style from the reference images. Each image can be a URL or base64. Griffin (default, 480p) and Griffin HD (720p) generate a soundtrack; note the per-second rate here is higher than createVideo's for the same model. The job result is the video URL and its actual duration in seconds. Choose the output shape with `aspect_ratio` (\"default\" lets the model decide). The chosen `model` and `duration` must be compatible (incompatible combinations return HTTP 400). Credits are held when the job is accepted; the final charge is rate × produced seconds, never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. Pass an optional `request_id` to tag the result so you can locate it later via listGenerations (type video). Related tools: `createVideo` for image-to-video, `editVideo` to modify a generated video. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Griffin (2.5 credits/s, shortest duration 5s, so 12.5 credits minimum; 5s = 12.5, 6s = 15, 7s = 17.5, 8s = 20, 9s = 22.5, 10s = 25, 11s = 27.5, 12s = 30, 13s = 32.5, 14s = 35, 15s = 37.5) · Griffin HD (4 credits/s, shortest duration 5s, so 20 credits minimum; 5s = 20, 6s = 24, 7s = 28, 8s = 32, 9s = 36, 10s = 40, 11s = 44, 12s = 48, 13s = 52, 14s = 56, 15s = 60) · Eagle (1.5 credits/s; 1s = 1.5, 2s = 3, 3s = 4.5, 4s = 6, 5s = 7.5, 6s = 9, 7s = 10.5, 8s = 12, 9s = 13.5, 10s = 15, 11s = 16.5, 12s = 18, 13s = 19.5, 14s = 21, 15s = 22.5) - LEGACY - scheduled for removal, do not use for new work · Eagle with Audio (2 credits/s; 1s = 2, 2s = 4, 3s = 6, 4s = 8, 5s = 10, 6s = 12, 7s = 14, 8s = 16, 9s = 18, 10s = 20, 11s = 22, 12s = 24, 13s = 26, 14s = 28, 15s = 30) - LEGACY - scheduled for removal, do not use for new work.", "x-mcp-description": "Generate a video from 1-5 reference images and a text prompt (references-to-video). Unlike createVideo, which animates a single source image, this composes a new scene that borrows characters, objects, and style from the reference images. Each image can be a URL or base64. Griffin (default, 480p) and Griffin HD (720p) generate a soundtrack; note the per-second rate here is higher than createVideo's for the same model. The job result is the video URL and its actual duration in seconds. Choose the output shape with `aspect_ratio` (\"default\" lets the model decide). The chosen `model` and `duration` must be compatible (incompatible combinations return HTTP 400). Credits are held when the job is accepted; the final charge is rate × produced seconds, never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. Pass an optional `request_id` to tag the result so you can locate it later via listGenerations (type video). Related tools: `createVideo` for image-to-video, `editVideo` to modify a generated video. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: credits/s × seconds, per model: Griffin 2.5/s (shortest duration 5s, so 12.5 credits minimum), Griffin HD 4/s (shortest duration 5s, so 20 credits minimum), Eagle 1.5/s [LEGACY], Eagle with Audio 2/s [LEGACY]; [LEGACY] models are scheduled for removal - do not use them for new work; see this endpoint's full pricing table in the API docs." } }, "/assets/video/edit": { "post": { "summary": "editVideo", "tags": [ "Videos" ], "operationId": "editVideo", "x-credit-action": "VIDEO_EDIT", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditVideoPayloadPublic" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/video/edit\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"prompt\":\"string\",\"video\":\"\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/video/edit\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"prompt\": \"string\",\n \"video\": \"\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/video/edit\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"prompt\": \"string\",\n \"video\": \"\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Griffin HD (2 credits/s; 5s = 10, 6s = 12, 7s = 14, 8s = 16, 9s = 18, 10s = 20, 11s = 22, 12s = 24, 13s = 26, 14s = 28, 15s = 30) · Eagle (2 credits/s; 1s = 2, 2s = 4, 3s = 6, 4s = 8, 5s = 10, 6s = 12, 7s = 14, 8s = 16, 9s = 18, 10s = 20, 11s = 22, 12s = 24, 13s = 26, 14s = 28, 15s = 30) - LEGACY - scheduled for removal, do not use for new work", "x-credit-summary": "credits/s × seconds, per model: Griffin HD 2/s, Eagle 2/s [LEGACY]; [LEGACY] models are scheduled for removal - do not use them for new work; see this endpoint's full pricing table in the API docs", "description": "Edit a previously generated video with a text prompt and optional reference images (video-to-video); runs on griffin-hd (720p, with soundtrack) and the output keeps the source video's duration unless you pass one. Pass the video `url` you received from `createVideo`, `createVideoFromReferences`, or an earlier edit - it must be a video you generated within the last 7 days; arbitrary external videos are not accepted. Optionally add up to 5 reference `images` (URL or base64) to guide the edit. The job result is the new video URL and its actual duration in seconds. Credits are held when the job is accepted; the final charge is rate × produced seconds, never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. Pass an optional `request_id` to tag the result so you can locate it later via listGenerations (type video). Related tools: `createVideo` to generate the source clip, `createVideoFromReferences` for reference-driven generation. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint's credit cost varies by model and duration (credits/s × seconds, rounded to 0.1; a model's minimum charge applies when that product is lower). Available models: Griffin HD (2 credits/s; 5s = 10, 6s = 12, 7s = 14, 8s = 16, 9s = 18, 10s = 20, 11s = 22, 12s = 24, 13s = 26, 14s = 28, 15s = 30) · Eagle (2 credits/s; 1s = 2, 2s = 4, 3s = 6, 4s = 8, 5s = 10, 6s = 12, 7s = 14, 8s = 16, 9s = 18, 10s = 20, 11s = 22, 12s = 24, 13s = 26, 14s = 28, 15s = 30) - LEGACY - scheduled for removal, do not use for new work.", "x-mcp-description": "Edit a previously generated video with a text prompt and optional reference images (video-to-video); runs on griffin-hd (720p, with soundtrack) and the output keeps the source video's duration unless you pass one. Pass the video `url` you received from `createVideo`, `createVideoFromReferences`, or an earlier edit - it must be a video you generated within the last 7 days; arbitrary external videos are not accepted. Optionally add up to 5 reference `images` (URL or base64) to guide the edit. The job result is the new video URL and its actual duration in seconds. Credits are held when the job is accepted; the final charge is rate × produced seconds, never more than for the duration you requested, and the difference (or everything, if the job fails or is cancelled) is refunded. Pass an optional `request_id` to tag the result so you can locate it later via listGenerations (type video). Related tools: `createVideo` to generate the source clip, `createVideoFromReferences` for reference-driven generation. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: credits/s × seconds, per model: Griffin HD 2/s, Eagle 2/s [LEGACY]; [LEGACY] models are scheduled for removal - do not use them for new work; see this endpoint's full pricing table in the API docs." } }, "/assets/video/upscale": { "post": { "summary": "upscaleVideo", "tags": [ "Videos" ], "operationId": "upscaleVideo", "x-credit-action": "UPSCALE_VIDEO", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpscaleVideoPayloadPublic" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/video/upscale\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"video\":\"\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/video/upscale\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"video\": \"\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/video/upscale\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"video\": \"\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "0.2 credits per second of video", "x-credit-summary": "0.2 credits per second of video", "description": "Upscale a previously generated video to twice its resolution (2x). Pass the video `url` you received from `createVideo`, `createVideoFromReferences`, or `editVideo` - it must be a video you generated within the last 7 days; arbitrary external videos are not accepted. Both dimensions of the source must be under 960 pixels: griffin (480p) output qualifies; griffin-hd (720p) output does not, landscape or portrait (only a square 720x720 would) - generate on griffin if you intend to upscale. A too-large source fails the job and the held credits are refunded. The job result is the new video URL (2x width and height, same duration) and its duration in seconds. Billed per second of video, independent of model; held when the job is accepted and refunded if it fails or is cancelled. Pass an optional `request_id` to tag the result so you can locate it later via listGenerations (type video). Related tools: `createVideo` for image-to-video, `editVideo` to modify a generated video. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** 0.2 credits per second of video.", "x-mcp-description": "Upscale a previously generated video to twice its resolution (2x). Pass the video `url` you received from `createVideo`, `createVideoFromReferences`, or `editVideo` - it must be a video you generated within the last 7 days; arbitrary external videos are not accepted. Both dimensions of the source must be under 960 pixels: griffin (480p) output qualifies; griffin-hd (720p) output does not, landscape or portrait (only a square 720x720 would) - generate on griffin if you intend to upscale. A too-large source fails the job and the held credits are refunded. The job result is the new video URL (2x width and height, same duration) and its duration in seconds. Billed per second of video, independent of model; held when the job is accepted and refunded if it fails or is cancelled. Pass an optional `request_id` to tag the result so you can locate it later via listGenerations (type video). Related tools: `createVideo` for image-to-video, `editVideo` to modify a generated video. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: 0.2 credits per second of video." } }, "/assets/image/remove-background": { "post": { "summary": "removeBackground", "tags": [ "Images" ], "operationId": "removeBackground", "x-credit-action": "GENERATE_IMAGE", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveBackgroundPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/image/remove-background\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"image\":\" OR data:image/png;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/image/remove-background\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"image\": \" OR data:image/png;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/image/remove-background\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"image\": \" OR data:image/png;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 0.5 credits per result", "x-credit-summary": "This endpoint consumes 0.5 credits per result", "description": "Remove the background from a single image, returning the subject isolated on a transparent background. Supply the source image (URL or base64); optionally set crop to trim the result to the content, and creative_edit (default true) for higher-quality output that may not match the input pixel-for-pixel - set it false when the subject must stay pixel-identical, e.g. an existing sprite you will animate. The job result is a single image result with a url (not an array). The image is uploaded and validated, and an image larger than 15MB is rejected with HTTP 400. Credits are held when the job is accepted and refunded if it fails or is cancelled. Use removeBackground for this dedicated cutout task; editImage can also remove backgrounds via a prompt but is better for broader edits, while createImage and generateWithStyle produce new images rather than process an existing one. Pass an optional request_id to tag the result so you can retrieve it later via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll `GET /assets/jobs/{id}`, honouring poll_after_ms or long-polling with wait=30, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 0.5 credits per result.", "x-mcp-description": "Remove the background from a single image, returning the subject isolated on a transparent background. Supply the source image (URL or base64); optionally set crop to trim the result to the content, and creative_edit (default true) for higher-quality output that may not match the input pixel-for-pixel - set it false when the subject must stay pixel-identical, e.g. an existing sprite you will animate. The job result is a single image result with a url (not an array). The image is uploaded and validated, and an image larger than 15MB is rejected with HTTP 400. Credits are held when the job is accepted and refunded if it fails or is cancelled. Use removeBackground for this dedicated cutout task; editImage can also remove backgrounds via a prompt but is better for broader edits, while createImage and generateWithStyle produce new images rather than process an existing one. Pass an optional request_id to tag the result so you can retrieve it later via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll `GET /assets/jobs/{id}`, honouring poll_after_ms or long-polling with wait=30, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 0.5 credits per result." } }, "/assets/image/upscale": { "post": { "summary": "upscaleImage", "tags": [ "Images" ], "operationId": "upscaleImage", "x-credit-action": "GENERATE_IMAGE", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpscaleImagePayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/image/upscale\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"image\":\" OR data:image/png;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/image/upscale\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"image\": \" OR data:image/png;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/image/upscale\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"image\": \" OR data:image/png;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 0.5 credits per result", "x-credit-summary": "This endpoint consumes 0.5 credits per result", "description": "Upscale an image: the same picture at a higher resolution, up to 4x, with the result capped at 2048px on its longest side. The source image (URL or base64) must be below 2048px on its longest side; a larger one is rejected with HTTP 400. The job result is a single image result with a url (not an array). The image is uploaded and validated, and an image larger than 15MB is rejected with HTTP 400. Credits are held when the job is accepted and refunded if it fails or is cancelled. Use upscaleImage to raise the resolution of an image you already have; createImage and editImage make new or changed images instead. Pass an optional request_id to tag the result so you can retrieve it later via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll `GET /assets/jobs/{id}`, honouring poll_after_ms or long-polling with wait=30, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 0.5 credits per result.", "x-mcp-description": "Upscale an image: the same picture at a higher resolution, up to 4x, with the result capped at 2048px on its longest side. The source image (URL or base64) must be below 2048px on its longest side; a larger one is rejected with HTTP 400. The job result is a single image result with a url (not an array). The image is uploaded and validated, and an image larger than 15MB is rejected with HTTP 400. Credits are held when the job is accepted and refunded if it fails or is cancelled. Use upscaleImage to raise the resolution of an image you already have; createImage and editImage make new or changed images instead. Pass an optional request_id to tag the result so you can retrieve it later via listGenerations (type image). Requires an API key (user scope). The call returns 202 with a job id - poll `GET /assets/jobs/{id}`, honouring poll_after_ms or long-polling with wait=30, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 0.5 credits per result." } }, "/assets/3d-model": { "post": { "summary": "create3DModel", "tags": [ "3D Models" ], "operationId": "create3DModel", "x-credit-action": "GENERATE_3D_MODEL", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Create3DModelPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model3DResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/3d-model\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"image\":\" OR data:image/png;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/3d-model\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"image\": \" OR data:image/png;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/3d-model\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"image\": \" OR data:image/png;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 4 credits per call with model \"prop\" (default), 15 credits per call with model \"hero\"; rig true adds 1 credit when the model comes back rigged", "x-credit-summary": "This endpoint consumes 4 credits per call with model \"prop\" (default), 15 credits per call with model \"hero\"; rig true adds 1 credit when the model comes back rigged", "description": "Convert a source image into a textured 3D model (image-to-3D). The job result is a downloadable GLB model_url plus an array of snapshot image URLs rendered from different angles (handy for previews). model picks the generator: prop (default) is low-cost and suits everyday props and environment pieces; hero is far more detailed and accurate, for close-up assets, but slower and more expensive. image is the front view; with prop, pass an optional back_image (the same subject seen from behind) so the back of the model follows it instead of being invented - hero takes the front image only and rejects a back_image with HTTP 400. Accepts optional mesh controls: target_num_faces (max triangle count, 1000-200000, default 50000), texture_size (1024 or 2048, default 2048), and texture_type (\"pbr\", \"simple\", or \"none\", default \"pbr\"). Pass rig true to also rig the model in the same call, with the general rig (joint_naming as in rigModel), ready for animate3DModelPreset or createDirectionalSprites; that adds the rigModel price, charged only when the result comes back rigged. Credits are held when the job is accepted and refunded if it fails or is cancelled. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type 3d). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 4 credits per call with model \"prop\" (default), 15 credits per call with model \"hero\"; rig true adds 1 credit when the model comes back rigged.", "x-mcp-description": "Convert a source image into a textured 3D model (image-to-3D). The job result is a downloadable GLB model_url plus an array of snapshot image URLs rendered from different angles (handy for previews). model picks the generator: prop (default) is low-cost and suits everyday props and environment pieces; hero is far more detailed and accurate, for close-up assets, but slower and more expensive. image is the front view; with prop, pass an optional back_image (the same subject seen from behind) so the back of the model follows it instead of being invented - hero takes the front image only and rejects a back_image with HTTP 400. Accepts optional mesh controls: target_num_faces (max triangle count, 1000-200000, default 50000), texture_size (1024 or 2048, default 2048), and texture_type (\"pbr\", \"simple\", or \"none\", default \"pbr\"). Pass rig true to also rig the model in the same call, with the general rig (joint_naming as in rigModel), ready for animate3DModelPreset or createDirectionalSprites; that adds the rigModel price, charged only when the result comes back rigged. Credits are held when the job is accepted and refunded if it fails or is cancelled. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type 3d). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 4 credits per call with model \"prop\" (default), 15 credits per call with model \"hero\"; rig true adds 1 credit when the model comes back rigged." } }, "/assets/3d-model/rig": { "post": { "summary": "rigModel", "tags": [ "3D Models" ], "operationId": "rigModel", "x-credit-action": "RIG_3D_MODEL", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rig3DModelPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rig3DModelResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/3d-model/rig\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"model\":\" OR data:model/gltf-binary;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/3d-model/rig\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"model\": \" OR data:model/gltf-binary;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/3d-model/rig\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"model\": \" OR data:model/gltf-binary;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 1 credits per call", "x-credit-summary": "This endpoint consumes 1 credits per call", "description": "Rig a 3D model: generate a skeleton and skin weights for an existing GLB so it can be animated. Accepts a URL or base64-encoded GLB in `model` (here `model` is the 3D asset file, not an AI model name - rigging has no model choice). The job result is a downloadable `model_url` for the rigged GLB. rig_type selects the skeleton prior - general (default, any asset), humanoid (anime-style characters), game (classic game-character rigs), or the pinned humanoid templates for two-armed, two-legged characters: humanoid_template (standard 22-joint skeleton with named joints) and humanoid_template_hands (52 joints, five fingers per hand). Animation presets retarget onto any rig type, though not onto every model. joint_naming relabels the identified joints to a convention - smpl (default), mixamo, humanik, unreal, godot, rigify, or vroid - without changing the skeleton. Credits are held when the job is accepted and refunded if it fails or is cancelled. Rigging is non-destructive to geometry but replaces any prior skeleton, so animations made against an old rig no longer apply. Requires an API key (user scope). The call returns 202 with a job id - poll `GET /assets/jobs/{id}`, honouring poll_after_ms or long-polling with wait=30, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 1 credits per call.", "x-mcp-description": "Rig a 3D model: generate a skeleton and skin weights for an existing GLB so it can be animated. Accepts a URL or base64-encoded GLB in `model` (here `model` is the 3D asset file, not an AI model name - rigging has no model choice). The job result is a downloadable `model_url` for the rigged GLB. rig_type selects the skeleton prior - general (default, any asset), humanoid (anime-style characters), game (classic game-character rigs), or the pinned humanoid templates for two-armed, two-legged characters: humanoid_template (standard 22-joint skeleton with named joints) and humanoid_template_hands (52 joints, five fingers per hand). Animation presets retarget onto any rig type, though not onto every model. joint_naming relabels the identified joints to a convention - smpl (default), mixamo, humanik, unreal, godot, rigify, or vroid - without changing the skeleton. Credits are held when the job is accepted and refunded if it fails or is cancelled. Rigging is non-destructive to geometry but replaces any prior skeleton, so animations made against an old rig no longer apply. Requires an API key (user scope). The call returns 202 with a job id - poll `GET /assets/jobs/{id}`, honouring poll_after_ms or long-polling with wait=30, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 1 credits per call." } }, "/assets/3d-model/animate": { "post": { "summary": "animate3DModel", "tags": [ "3D Models" ], "operationId": "animate3DModel", "x-credit-action": "ANIMATE_3D_MODEL", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Animate3DModelPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnimationCandidates" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/3d-model/animate\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"model\":\" OR data:model/gltf-binary;base64,...\",\"prompt\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/3d-model/animate\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"model\": \" OR data:model/gltf-binary;base64,...\",\n \"prompt\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/3d-model/animate\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"model\": \" OR data:model/gltf-binary;base64,...\",\n \"prompt\": \"string\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 0.5 credits per call", "x-credit-summary": "This endpoint consumes 0.5 credits per call", "description": "Generate text-driven skeletal animations for an already-rigged 3D model. Pass the rigged GLB in `model` (URL or base64; the 3D asset file, not an AI model name) and a motion `prompt` (e.g. \"walking\", \"swinging its axe\"). The model must already have a skeleton - rig it first with rigModel if not. The job result is num_variants candidate animations (default 4), each a standalone animation-only GLB (skeleton + one clip, no mesh) in `glb_url` plus an mp4 `preview_url`, so you can pick the best one and fuse it with your model in a game engine or three.js. mode selects the representation - rot_trans (default, rotation plus translation per bone, most faithful) or rot_only (rotation only, easier to retarget onto another skeleton in an engine). Animation quality is hit-or-miss, which is why multiple candidates are returned. Credits are held once per call regardless of variant count and refunded if the job fails or is cancelled. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 0.5 credits per call.", "x-mcp-description": "Generate text-driven skeletal animations for an already-rigged 3D model. Pass the rigged GLB in `model` (URL or base64; the 3D asset file, not an AI model name) and a motion `prompt` (e.g. \"walking\", \"swinging its axe\"). The model must already have a skeleton - rig it first with rigModel if not. The job result is num_variants candidate animations (default 4), each a standalone animation-only GLB (skeleton + one clip, no mesh) in `glb_url` plus an mp4 `preview_url`, so you can pick the best one and fuse it with your model in a game engine or three.js. mode selects the representation - rot_trans (default, rotation plus translation per bone, most faithful) or rot_only (rotation only, easier to retarget onto another skeleton in an engine). Animation quality is hit-or-miss, which is why multiple candidates are returned. Credits are held once per call regardless of variant count and refunded if the job fails or is cancelled. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 0.5 credits per call." } }, "/assets/3d-model/animate-preset": { "post": { "summary": "animate3DModelPreset", "tags": [ "3D Models" ], "operationId": "animate3DModelPreset", "x-credit-action": "ANIMATE_3D_PRESET", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Animate3DPresetModelPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnimationCandidates" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/3d-model/animate-preset\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"model\":\" OR data:model/gltf-binary;base64,...\",\"preset_id\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/3d-model/animate-preset\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"model\": \" OR data:model/gltf-binary;base64,...\",\n \"preset_id\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/3d-model/animate-preset\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"model\": \" OR data:model/gltf-binary;base64,...\",\n \"preset_id\": \"string\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 0.5 credits per call", "x-credit-summary": "This endpoint consumes 0.5 credits per call", "description": "Apply a curated animation preset to an already-rigged 3D model (retargeting). Pass the rigged GLB in `model` (URL or base64; the 3D asset file, not an AI model name) and a `preset_id` from the animation presets list (from listAnimationPresets; any preset id works). Any rig type can take a preset, though retargeting does not succeed on every model: when it does not, the job fails. The job result is one retargeted animation - a standalone animation-only GLB in `glb_url` plus an mp4 `preview_url` - in the same `animations` envelope as the animate endpoint. crop_loop trims the clip to its seamlessly-looping span (omit to follow the preset's own loop flag); in_place removes net travel so the character moves on the spot, as game-engine locomotion expects (omit to keep the preset's own travel). Credits are held when the job is accepted and refunded if it fails or is cancelled. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 0.5 credits per call.", "x-mcp-description": "Apply a curated animation preset to an already-rigged 3D model (retargeting). Pass the rigged GLB in `model` (URL or base64; the 3D asset file, not an AI model name) and a `preset_id` from the animation presets list (from listAnimationPresets; any preset id works). Any rig type can take a preset, though retargeting does not succeed on every model: when it does not, the job fails. The job result is one retargeted animation - a standalone animation-only GLB in `glb_url` plus an mp4 `preview_url` - in the same `animations` envelope as the animate endpoint. crop_loop trims the clip to its seamlessly-looping span (omit to follow the preset's own loop flag); in_place removes net travel so the character moves on the spot, as game-engine locomotion expects (omit to keep the preset's own travel). Credits are held when the job is accepted and refunded if it fails or is cancelled. Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 0.5 credits per call." } }, "/audio/sound-effect": { "post": { "summary": "createSoundEffect", "tags": [ "Audio" ], "operationId": "createSoundEffect", "x-credit-action": "GENERATE_AUDIO_SFX", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSoundEffectPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/audio/sound-effect\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"description\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/audio/sound-effect\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"description\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/audio/sound-effect\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"description\": \"string\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 2 credits per call", "x-credit-summary": "This endpoint consumes 2 credits per call", "description": "Produce a short sound effect (SFX) from a text description, such as \"laser gun firing\" or \"footsteps on gravel\". The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). The description field is required, duration is capped at 10 seconds (0 means auto-pick based on the description), and you may set loop to true for a seamlessly looping effect. Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this for short, discrete sounds; use createAmbiance for a continuous looping background soundscape, createMusic for musical pieces, and createAudioTransform to remix an existing audio sample. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 2 credits per call.", "x-mcp-description": "Produce a short sound effect (SFX) from a text description, such as \"laser gun firing\" or \"footsteps on gravel\". The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). The description field is required, duration is capped at 10 seconds (0 means auto-pick based on the description), and you may set loop to true for a seamlessly looping effect. Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this for short, discrete sounds; use createAmbiance for a continuous looping background soundscape, createMusic for musical pieces, and createAudioTransform to remix an existing audio sample. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 2 credits per call." } }, "/audio/ambiance": { "post": { "summary": "createAmbiance", "tags": [ "Audio" ], "operationId": "createAmbiance", "x-credit-action": "GENERATE_AUDIO_SFX", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAmbiancePayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/audio/ambiance\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"description\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/audio/ambiance\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"description\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/audio/ambiance\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"description\": \"string\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 2 credits per call", "x-credit-summary": "This endpoint consumes 2 credits per call", "description": "Produce a looping background ambiance soundscape from a text description, such as \"windy forest at dusk\" or \"busy tavern interior\". The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). The description field is required and duration is capped at 10 seconds (0 means auto-pick based on the description). Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this for continuous, atmospheric background loops; use createSoundEffect for short discrete sound effects, createMusic for musical pieces, and createAudioTransform to remix an existing audio sample. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 2 credits per call.", "x-mcp-description": "Produce a looping background ambiance soundscape from a text description, such as \"windy forest at dusk\" or \"busy tavern interior\". The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). The description field is required and duration is capped at 10 seconds (0 means auto-pick based on the description). Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this for continuous, atmospheric background loops; use createSoundEffect for short discrete sound effects, createMusic for musical pieces, and createAudioTransform to remix an existing audio sample. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 2 credits per call." } }, "/audio/music": { "post": { "summary": "createMusic", "tags": [ "Audio" ], "operationId": "createMusic", "x-credit-action": "GENERATE_AUDIO_MUSIC", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateMusicPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/audio/music\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"description\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/audio/music\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"description\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/audio/music\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"description\": \"string\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 3 credits per call", "x-credit-summary": "This endpoint consumes 3 credits per call", "description": "Produce a piece of music from a text description, such as \"epic orchestral battle theme\" or \"calm piano melody\", with optional lyrics. The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). The description field is required; duration must be one of the allowed values (0 means auto, otherwise multiples of 10 up to 180 seconds) and out-of-range values return HTTP 400. Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this for songs and musical scores; use createSoundEffect for short sound effects, createAmbiance for looping background soundscapes, and createAudioTransform to remix an existing audio sample. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 3 credits per call.", "x-mcp-description": "Produce a piece of music from a text description, such as \"epic orchestral battle theme\" or \"calm piano melody\", with optional lyrics. The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). The description field is required; duration must be one of the allowed values (0 means auto, otherwise multiples of 10 up to 180 seconds) and out-of-range values return HTTP 400. Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this for songs and musical scores; use createSoundEffect for short sound effects, createAmbiance for looping background soundscapes, and createAudioTransform to remix an existing audio sample. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 3 credits per call." } }, "/audio/transform": { "post": { "summary": "createAudioTransform", "tags": [ "Audio" ], "operationId": "createAudioTransform", "x-credit-action": "GENERATE_AUDIO_TRANSFORM", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAudioTransformPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/audio/transform\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"sample\":\" OR data:audio/mp3;base64,...\",\"prompt\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/audio/transform\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"sample\": \" OR data:audio/mp3;base64,...\",\n \"prompt\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/audio/transform\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"sample\": \" OR data:audio/mp3;base64,...\",\n \"prompt\": \"string\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 3 credits per call", "x-credit-summary": "This endpoint consumes 3 credits per call", "description": "Remix an existing audio sample (a sound effect, ambiance, or music clip) into a variation guided by a text prompt, for example turning a track into an 80s synthwave or metal version. Both the sample and the prompt are required; the sample is uploaded as a URL or base64 audio and must be at most 15MB or the call returns HTTP 400, and duration must be one of the allowed values (0 means match the source, otherwise multiples of 10 up to 180 seconds). The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). The optional modification_strength (0 to 1, default 0.6) controls how far the result departs from the original. Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this to transform existing audio you already have; use createSoundEffect, createAmbiance, or createMusic to generate audio from scratch. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 3 credits per call.", "x-mcp-description": "Remix an existing audio sample (a sound effect, ambiance, or music clip) into a variation guided by a text prompt, for example turning a track into an 80s synthwave or metal version. Both the sample and the prompt are required; the sample is uploaded as a URL or base64 audio and must be at most 15MB or the call returns HTTP 400, and duration must be one of the allowed values (0 means match the source, otherwise multiples of 10 up to 180 seconds). The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). The optional modification_strength (0 to 1, default 0.6) controls how far the result departs from the original. Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this to transform existing audio you already have; use createSoundEffect, createAmbiance, or createMusic to generate audio from scratch. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 3 credits per call." } }, "/audio/voice": { "post": { "summary": "createVoice", "tags": [ "Audio" ], "operationId": "createVoice", "x-credit-action": "GENERATE_AUDIO_VOICE", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateVoicePayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/audio/voice\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"text\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/audio/voice\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"text\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/audio/voice\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"text\": \"string\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 2 credits per call", "x-credit-summary": "This endpoint consumes 2 credits per call", "description": "Design a new voice from a character description (such as \"deep-voiced warrior\" or \"cheerful young girl\"), a character image, or both, and have it speak a short line of text, returning a sample of that newly created voice. text is required, plus voice_description or image (an image of the speaking character, given as a URL or base64, makes the description optional); the spoken text is limited to 100 characters or the call returns HTTP 400, and type selects \"human\" or \"non-human\" voices. The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this to invent and audition a voice from a description; use createSpeech for text-to-speech that clones a specific voice from an audio sample, and createSpeechPreset for text-to-speech using a named preset voice. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll `GET /assets/jobs/{id}`, honouring poll_after_ms or long-polling with wait=30, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 2 credits per call.", "x-mcp-description": "Design a new voice from a character description (such as \"deep-voiced warrior\" or \"cheerful young girl\"), a character image, or both, and have it speak a short line of text, returning a sample of that newly created voice. text is required, plus voice_description or image (an image of the speaking character, given as a URL or base64, makes the description optional); the spoken text is limited to 100 characters or the call returns HTTP 400, and type selects \"human\" or \"non-human\" voices. The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this to invent and audition a voice from a description; use createSpeech for text-to-speech that clones a specific voice from an audio sample, and createSpeechPreset for text-to-speech using a named preset voice. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll `GET /assets/jobs/{id}`, honouring poll_after_ms or long-polling with wait=30, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 2 credits per call." } }, "/audio/speech": { "post": { "summary": "createSpeech", "tags": [ "Audio" ], "operationId": "createSpeech", "security": [ { "ApiKey": [] } ], "x-credit-action": "GENERATE_AUDIO_SPEECH_CLONE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSpeechPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/audio/speech\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"text\":\"string\",\"sample\":\" OR data:audio/mp3;base64,...\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/audio/speech\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"text\": \"string\",\n \"sample\": \" OR data:audio/mp3;base64,...\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/audio/speech\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"text\": \"string\",\n \"sample\": \" OR data:audio/mp3;base64,...\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 2 credits per call", "x-credit-summary": "This endpoint consumes 2 credits per call", "description": "Convert text to speech by cloning the voice from an audio sample you provide (voice-cloning text-to-speech). Both text and sample are required; the text is limited to 250 characters and the sample is supplied as a URL or base64 audio that must be at most 15MB, with violations returning HTTP 400. An optional delivery note (at most 50 characters, e.g. \"angry, shouting\") says how the line is said. The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this when you have a reference voice sample to clone; use createSpeechPreset to speak with a built-in named preset voice instead, and createVoice to design a brand-new voice from a text description rather than cloning one. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 2 credits per call.", "x-mcp-description": "Convert text to speech by cloning the voice from an audio sample you provide (voice-cloning text-to-speech). Both text and sample are required; the text is limited to 250 characters and the sample is supplied as a URL or base64 audio that must be at most 15MB, with violations returning HTTP 400. An optional delivery note (at most 50 characters, e.g. \"angry, shouting\") says how the line is said. The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this when you have a reference voice sample to clone; use createSpeechPreset to speak with a built-in named preset voice instead, and createVoice to design a brand-new voice from a text description rather than cloning one. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 2 credits per call." } }, "/audio/speech-preset": { "post": { "summary": "createSpeechPreset", "tags": [ "Audio" ], "operationId": "createSpeechPreset", "x-credit-action": "GENERATE_AUDIO_SPEECH", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSpeechPresetPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioResult" } } } }, "202": { "description": "Accepted - the generation was queued; poll GET /assets/jobs/{id}. A synchronous (async: false) call still running after 15 minutes also receives this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/audio/speech-preset\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"text\":\"string\",\"voice_preset_id\":\"Serious woman\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/audio/speech-preset\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"text\": \"string\",\n \"voice_preset_id\": \"Serious woman\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/audio/speech-preset\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"text\": \"string\",\n \"voice_preset_id\": \"Serious woman\"\n }\n)\n\nprint(response.json())" } ], "x-credit-description": "This endpoint consumes 1 credits per call", "x-credit-summary": "This endpoint consumes 1 credits per call", "description": "Convert text to speech using a named built-in preset voice, with optional language and either an emotion or a delivery note, depending on the voice. Both text and voice_preset_id are required and the text is limited to 250 characters. The voices named by a first name (e.g. \"Rachel\") take a delivery note (at most 50 characters, e.g. \"angry, shouting\") and no emotion; the descriptive voices (e.g. \"Serious woman\") take an emotion and no delivery note. Invalid input, including an emotion or delivery note the voice does not take, returns HTTP 400. The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this when you want a ready-made catalog voice and do not need to supply your own sample; use createSpeech to clone a voice from an audio sample instead, and createVoice to design a new voice from a text description. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\n> **Credits:** This endpoint consumes 1 credits per call.", "x-mcp-description": "Convert text to speech using a named built-in preset voice, with optional language and either an emotion or a delivery note, depending on the voice. Both text and voice_preset_id are required and the text is limited to 250 characters. The voices named by a first name (e.g. \"Rachel\") take a delivery note (at most 50 characters, e.g. \"angry, shouting\") and no emotion; the descriptive voices (e.g. \"Serious woman\") take an emotion and no delivery note. Invalid input, including an emotion or delivery note the voice does not take, returns HTTP 400. The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this when you want a ready-made catalog voice and do not need to supply your own sample; use createSpeech to clone a voice from an audio sample instead, and createVoice to design a new voice from a text description. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).\n\nCredits: This endpoint consumes 1 credits per call." } }, "/assets/generations": { "get": { "description": "List your generation history - everything you have generated, through the API or in the Ludo web studio - most recent first. This is a free read-only lookup (no credits, no generation); it does not create anything. Pick a media `type` (image, spritesheet, video, audio, or 3d) and optionally narrow by free-text `search` (matched against tags, prompts and the other text on the asset), `source`, a `date_from`/`date_to` range (unix seconds), or the `request_id` you passed when you generated. Results are paginated with `page_size` (default 20, max 100) and 1-based `page_number`, and come back as an object: `items` (this page), plus `page`, `page_size` and `has_more`. Page until `has_more` is false rather than until you get a short page. `has_more` is computed by reading one row beyond the page, so it costs no extra query; there is deliberately no total count.\n\n`source` selects the surface an item came from: `api` returns only your API/MCP generations, `web` only your web-studio ones, `all` (the default) both. API-originated items expire 7 days after creation - their files live under a lifecycle-pruned storage prefix - so `source=api` never returns anything older than 7 days, while web items are kept indefinitely and are not time-bounded. API-originated results expire after 7 days - download anything you want to retain. (Assets can be kept permanently from the Ludo web app.) Each item carries an `id`, its generation-history id, which identifies the item across these listings. Every item also carries `type`, echoing the media type you asked for; on audio items the kind of audio (sfx, music, speech) is reported as `audio_type` so it does not collide with it.\n\nThis lists work that has already FINISHED. To follow a generation that is still queued or running, poll getApiJob with the job id you were given instead. Requires an API key (user scope).", "x-mcp-description": "List your generation history across the API and the web app - filter by type, source (api|web|all), text search, and date range. Returns {items, page, page_size, has_more}; keep paging while has_more is true. API-originated results expire after 7 days - download anything you want to retain. For an in-flight job's status use getApiJob instead.", "tags": [ "Generations" ], "operationId": "listGenerations", "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "type", "in": "query", "description": "Which kind of generation to list", "required": true, "schema": { "type": "string", "enum": [ "image", "spritesheet", "video", "audio", "3d" ] } }, { "name": "search", "in": "query", "description": "Free-text search. Every whitespace-separated term must match (case-insensitive substring) the item's tags or one of its text fields (prompt, hints, style, label, ...), so \"dwarf axe\" narrows to items matching both.", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Which surface the items were generated from: api (your API/MCP generations, last 7 days only), web (your Ludo web studio generations, no time limit), or all (default, both)", "required": false, "schema": { "type": "string", "enum": [ "api", "web", "all" ], "default": "all" } }, { "name": "date_from", "in": "query", "description": "Only return items generated at or after this time (unix seconds)", "required": false, "schema": { "type": "integer" } }, { "name": "date_to", "in": "query", "description": "Only return items generated at or before this time (unix seconds)", "required": false, "schema": { "type": "integer" } }, { "name": "page_size", "in": "query", "description": "Items per page (1-100)", "required": false, "schema": { "type": "integer", "default": 20 } }, { "name": "page_number", "in": "query", "description": "1-based page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "request_id", "in": "query", "description": "Only return items tagged with this request_id when you generated them", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationList" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/generations\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/generations\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/generations\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/images/results": { "get": { "description": "**Deprecated:** prefer `GET /assets/generations` (all types, paginated, same source filter). This endpoint continues to work; no removal is scheduled.\nList images you previously generated through the API, most recent first. This is a free read-only history lookup (no credits, no generation); it does not create anything. Pass an optional request_id query parameter to return only the results tagged with that id when you originally called createImage, editImage, generateWithStyle, generatePose, rotateSprite, or removeBackground. Requires an API key (user scope).", "tags": [ "Images" ], "operationId": "getImageResults", "deprecated": true, "x-mcp-exclude": true, "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "request_id", "in": "query", "description": "Filter results by request_id", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Which surface the results were generated from: api (default, your API/MCP generations from the last 7 days), web (your Ludo web studio generations, no time limit), or all", "required": false, "schema": { "type": "string", "enum": [ "api", "web", "all" ], "default": "api" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImageResult" } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/images/results\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/images/results\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/images/results\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/sprites/results": { "get": { "description": "**Deprecated:** prefer `GET /assets/generations` (all types, paginated, same source filter). This endpoint continues to work; no removal is scheduled.\nList spritesheets you previously generated through the API, most recent first. This is a free read-only history lookup (no credits, no generation); it does not create anything. Pass an optional request_id query parameter to return only the results tagged with that id when you originally called animateSprite or transferMotion. Requires an API key (user scope).", "tags": [ "Spritesheets" ], "operationId": "getSpriteResults", "deprecated": true, "x-mcp-exclude": true, "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "request_id", "in": "query", "description": "Filter results by request_id", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Which surface the results were generated from: api (default, your API/MCP generations from the last 7 days), web (your Ludo web studio generations, no time limit), or all", "required": false, "schema": { "type": "string", "enum": [ "api", "web", "all" ], "default": "api" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpriteResult" } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/sprites/results\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/sprites/results\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/sprites/results\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/videos/results": { "get": { "description": "**Deprecated:** prefer `GET /assets/generations` (all types, paginated, same source filter). This endpoint continues to work; no removal is scheduled.\nList videos you previously generated through the API, most recent first. This is a free read-only history lookup (no credits, no generation); it does not create anything. Pass an optional request_id query parameter to return only the results tagged with that id when you originally called createVideo. Requires an API key (user scope).", "tags": [ "Videos" ], "operationId": "getVideoResults", "deprecated": true, "x-mcp-exclude": true, "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "request_id", "in": "query", "description": "Filter results by request_id", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Which surface the results were generated from: api (default, your API/MCP generations from the last 7 days), web (your Ludo web studio generations, no time limit), or all", "required": false, "schema": { "type": "string", "enum": [ "api", "web", "all" ], "default": "api" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VideoResult" } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/videos/results\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/videos/results\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/videos/results\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/audio/results": { "get": { "description": "**Deprecated:** prefer `GET /assets/generations` (all types, paginated, same source filter). This endpoint continues to work; no removal is scheduled.\nList audio clips you previously generated through the API, most recent first. This is a free read-only history lookup (no credits, no generation); it does not create anything. Pass an optional request_id query parameter to return only the results tagged with that id when you originally called createSoundEffect, createAmbiance, createMusic, createAudioTransform, createVoice, createSpeech, or createSpeechPreset. Requires an API key (user scope).", "tags": [ "Audio" ], "operationId": "getAudioResults", "deprecated": true, "x-mcp-exclude": true, "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "request_id", "in": "query", "description": "Filter results by request_id", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Which surface the results were generated from: api (default, your API/MCP generations from the last 7 days), web (your Ludo web studio generations, no time limit), or all", "required": false, "schema": { "type": "string", "enum": [ "api", "web", "all" ], "default": "api" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AudioResult" } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/audio/results\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/audio/results\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/audio/results\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/3d-models/results": { "get": { "description": "**Deprecated:** prefer `GET /assets/generations` (all types, paginated, same source filter). This endpoint continues to work; no removal is scheduled.\nList 3D models you previously generated through the API, most recent first. This is a free read-only history lookup (no credits, no generation); it does not create anything. Pass an optional request_id query parameter to return only the results tagged with that id when you originally called create3DModel. Requires an API key (user scope).", "tags": [ "3D Models" ], "operationId": "get3DModelResults", "deprecated": true, "x-mcp-exclude": true, "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "request_id", "in": "query", "description": "Filter results by request_id", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Which surface the results were generated from: api (default, your API/MCP generations from the last 7 days), web (your Ludo web studio generations, no time limit), or all", "required": false, "schema": { "type": "string", "enum": [ "api", "web", "all" ], "default": "api" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ThreeDModelResult" } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/3d-models/results\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/3d-models/results\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/3d-models/results\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/jobs": { "get": { "description": "List the generation jobs you started through the API or MCP, most recent first. Web-app jobs are not included. This is a free read-only lookup (no credits, no generation). Filter with a comma-separated status list; limit defaults to 50 and is capped at 100. Requires an API key (user scope).", "tags": [ "Jobs" ], "operationId": "listApiJobs", "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "status", "in": "query", "description": "Comma-separated statuses to include (queued, running, succeeded, failed, canceled). Defaults to all.", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of jobs to return. Defaults to 50, capped at 100.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicJob" } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/jobs\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/jobs\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/jobs\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/jobs/{id}": { "get": { "description": "Fetch one job you started through the API or MCP. Statuses: queued, running (both non-terminal - the response carries poll_after_ms, wait at least that long before asking again), then succeeded (read `result`), failed (read `error`: {code, subcode, message, retriable}; the held credits are refunded) or canceled. Generations typically finish within a few minutes; a job still queued after 15 minutes can be cancelled and resubmitted. Better still, pass wait= (up to 60) to long-poll: the request is held until the job reaches a terminal state, so one call replaces a polling loop. Once status is succeeded, `result` holds exactly what the synchronous form of the operation named by task_type would have returned. This is a free read-only lookup (no credits). Requires an API key (user scope).", "tags": [ "Jobs" ], "operationId": "getApiJob", "x-mcp-description": "Poll the status of a generation job started by any tool. Every generation tool returns `{id, status}`; call getApiJob with that id until status is `succeeded` (then read `result`, shaped exactly like the tool's documented output) or `failed` (read `error`). Poll every few seconds, or pass `wait: 30` to long-poll - the call is held up to 30 seconds (max 60) and returns as soon as the job finishes.", "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "The job id returned by a generation call (its `id` in the 202 response).", "required": true, "schema": { "type": "string" } }, { "name": "wait", "in": "query", "description": "Seconds to long-poll for a terminal state (0-60). Defaults to 0 (return immediately).", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "No such job for this API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/jobs/{id}\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/jobs/{id}\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/jobs/{id}\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] }, "delete": { "description": "Cancel a queued job you started through the API or MCP; the credits held for it are refunded. Jobs that are already running cannot be canceled (409). Returns the canceled job. This is free (no credits). Requires an API key (user scope).", "tags": [ "Jobs" ], "operationId": "cancelApiJob", "security": [ { "ApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicJob" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "No such job for this API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Job is not in a cancelable state (e.g. already running)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X DELETE \"https://api.ludo.ai/api/assets/jobs/{id}\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/jobs/{id}\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.delete(\n \"https://api.ludo.ai/api/assets/jobs/{id}\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/uploads": { "post": { "description": "Start an upload of a local file, so it can be passed to a generation endpoint by URL instead of inline as base64. Declare the file's MIME type and exact size in bytes (up to 15MB, the same limit the generation endpoints apply); the response carries an upload_url and a file_url. Send the file's bytes in a single PUT to upload_url (no Authorization header; the content type and size are fixed by this call, and a body of any other size is refused). Once the PUT succeeds, pass file_url in any image, audio, video or model field that accepts a URL. The file is public to anyone holding file_url and is deleted 7 days after upload. upload_url is single-use. Free (no credits). Requires an API key (user scope). Not exposed as an MCP tool.", "tags": [ "Files" ], "operationId": "createUpload", "x-mcp-exclude": true, "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUploadPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadSession" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/uploads\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"mime_type\":\"image/png\",\"size\":1}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/uploads\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"mime_type\": \"image/png\",\n \"size\": 1\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/uploads\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"mime_type\": \"image/png\",\n \"size\": 1\n }\n)\n\nprint(response.json())" } ] } }, "/assets/account": { "get": { "description": "Show your account's credit balance, plan and auto top-up settings. `credits.available` is what generations can spend right now (plan_credits + extra - used); `resets_at` is when the plan's monthly credits refill (unix seconds). When `team_pool` is true the balance is your team's shared pool, and `auto_topup` is null because the team owner manages it. Check this before an expensive generation instead of waiting for a 402. Buying credits and changing auto top-up happen in the web app at `billing_url`. This is a free read-only lookup (no credits, no generation). Requires an API key (user scope).", "tags": [ "Account" ], "operationId": "getAccount", "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \"https://api.ludo.ai/api/assets/account\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/account\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/assets/account\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/cli-key": { "delete": { "description": "Revoke the key making this call, when it was created by a browser login. Other API keys are managed in the web app. Free. Requires an API key (user scope).", "tags": [ "Account" ], "operationId": "revokeCurrentCliKey", "x-mcp-exclude": true, "security": [ { "ApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "400": { "description": "Not a browser-login key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X DELETE \"https://api.ludo.ai/api/assets/cli-key\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/cli-key\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.delete(\n \"https://api.ludo.ai/api/assets/cli-key\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())" } ] } }, "/assets/feedback": { "post": { "description": "Report a problem with the Ludo API itself to the Ludo team. Use it ONLY for API bugs (an error, a failed or stuck job, a crash, a response that does not match this documentation) and API limitations (a parameter, operation or format you needed that the API does not support, and that you could not work around). NEVER use it to report model limitations or the quality of a result: an image, sprite, animation, 3D model, video or sound that looks wrong, ignores part of the prompt, has artifacts or is not what you wanted is not an API bug. Do not report those; retry with a different prompt, model or settings instead. Before reporting a limitation, call searchDocs with what you tried: if the docs already describe it as a known limitation, do not report it. Describe what you were trying to do and what went wrong, and name the operation it relates to. Always send the id of every job the report is about, in job_ids (up to 10): we look at those jobs' inputs and outputs, and a report about a result we cannot find cannot be investigated. Do not include personal data, secrets or file contents. Send one report per issue, and if you are an agent, tell the user what you sent. Free (no credits). Requires an API key (user scope).", "tags": [ "Account" ], "operationId": "submitApiFeedback", "security": [ { "ApiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiFeedbackPayload" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiFeedbackReceipt" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \"https://api.ludo.ai/api/assets/feedback\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"category\":\"limitation\",\"message\":\"string\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const response = await fetch(\"https://api.ludo.ai/api/assets/feedback\", {\n method: \"POST\",\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"category\": \"limitation\",\n \"message\": \"string\"\n })\n});\n\nconst data = await response.json();\nconsole.log(data);" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://api.ludo.ai/api/assets/feedback\",\n headers={\n \"Authorization\": \"ApiKey YOUR_API_KEY\",\n \"Content-Type\": \"application/json\"\n },\n json={\n \"category\": \"limitation\",\n \"message\": \"string\"\n }\n)\n\nprint(response.json())" } ] } } }, "tags": [ { "name": "Authentication" } ], "servers": [ { "url": "/api" } ], "components": { "securitySchemes": { "ApiKey": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "For accessing the API a valid API Key token must be passed in all the queries in\nthe 'Authorization' header.\nThe following syntax must be used in the 'Authorization' header: ApiKey xxxxxx.yyyyyyy.zzzzzz\n" } }, "schemas": { "ErrorResponse": { "type": "object", "properties": { "message": { "type": "string" }, "metadata": { "type": "string" }, "error_payload": { "type": "string" }, "intent": { "type": "object", "description": "Stripe intent details sent with 3D Secure (406) errors", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "payment", "setup" ], "example": "payment" }, "client_secret": { "type": "string" } } } } }, "GenerateImagePayload": { "type": "object", "description": "Payload for generating an image from text prompt", "required": [ "image_type", "prompt" ], "properties": { "image_type": { "type": "string", "description": "What kind of image to generate.", "enum": [ "generic", "screenshot", "art", "asset", "sprite", "sprite-vfx", "sprite-tiling-horizontal", "sprite-tiling-vertical", "icon", "logo", "ui_asset", "fixed_background", "side_scrolling_background", "vertical_scrolling_background", "parallax_layer", "texture", "tile", "item-icon", "portrait", "card-art", "splash", "3d" ], "example": "generic" }, "prompt": { "type": "string", "description": "Text description of the image to generate. The more detailed the prompt, the more accurate the image will be." }, "art_style": { "type": "string", "description": "Visual art style for the sprite (e.g., \"Pixel Art\", \"Cartoonish\", \"Realistic\").", "enum": [ "Any style", "Cel-Shaded", "Inked Painterly", "Illustration", "Western Cartoon", "Anime/Manga", "Chibi", "8-Bit", "16-Bit", "32-Bit", "Hi-Bit", "Retro 2D", "Hand-Painted", "Digital Painting", "Comic Book", "Block Print", "Sketch", "Watercolor", "Stylized 3D", "Pixar Style", "Low Poly", "Photorealistic 3D", "Voxel Art", "Retro 3D", "Flat Design", "Minimalist", "Silhouette", "Noir", "Neon", "Glitch Art", "Claymation", "Paper Craft", "Textile" ], "example": "Any style" }, "perspective": { "type": "string", "description": "Camera angle/view for the sprite (e.g., \"Side view\", \"Front view\", \"Isometric\").", "enum": [ "Any perspective", "Side-Scroll", "Isometric", "High Angle", "Top-Down", "2.5D", "First-Person", "Third-Person", "Over-the-Shoulder", "Free Camera" ], "example": "Any perspective" }, "aspect_ratio": { "type": "string", "description": "Aspect ratio of the output image.", "enum": [ "default", "ar_1_1", "ar_4_3", "ar_16_9", "ar_19_9", "ar_3_4", "ar_9_16", "ar_9_19" ], "example": "default" }, "n": { "type": "integer", "format": "integer", "default": 1, "minimum": 1, "maximum": 8, "description": "Number of image variations to generate", "example": 1 }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "ImageResult": { "type": "object", "properties": { "url": { "type": "string", "example": "" }, "request_id": { "type": "string" }, "created_at": { "type": "integer" } } }, "PublicJob": { "type": "object", "required": [ "id", "task_type", "status", "created_at" ], "properties": { "id": { "type": "string" }, "task_type": { "type": "string", "description": "The public operationId that created this job (e.g. createImage). Determines the shape of `result`: it is exactly the 200 response body documented for that operation." }, "status": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "canceled" ], "example": "queued" }, "request_id": { "type": "string" }, "created_at": { "type": "integer", "format": "int64", "description": "Unix ms" }, "finished_at": { "type": "integer", "format": "int64" }, "credits_charged": { "type": "number", "format": "float", "description": "Credits this job cost you. Charged at enqueue; reported as 0 once a job fails or is canceled, since the charge is refunded." }, "result": { "type": "object", "description": "Present only when status is succeeded. Same shape as the synchronous response of the operation named by task_type." }, "error": { "$ref": "#/components/schemas/PublicJobError" }, "poll_after_ms": { "type": "integer", "format": "int32", "description": "Present while the job is queued or running: wait at least this many milliseconds before polling again. Prefer GET /assets/jobs/{id}?wait=30 (long-poll) over tight loops." } } }, "GenerateWithStylePayload": { "type": "object", "description": "Payload for generating new content while maintaining the visual style of a reference image", "required": [ "style_image", "prompt" ], "properties": { "style_image": { "type": "string", "description": "URL or base64-encoded reference image whose visual style should be matched.", "example": " OR data:image/png;base64,..." }, "prompt": { "type": "string", "description": "Text description of what to generate (e.g., \"a warrior character\", \"a forest background\", \"a treasure chest\")." }, "image_type": { "type": "string", "description": "What kind of image to generate.", "default": "sprite", "enum": [ "generic", "screenshot", "art", "asset", "sprite", "sprite-vfx", "sprite-tiling-horizontal", "sprite-tiling-vertical", "icon", "logo", "ui_asset", "fixed_background", "side_scrolling_background", "vertical_scrolling_background", "parallax_layer", "texture", "tile", "item-icon", "portrait", "card-art", "splash", "3d" ], "example": "sprite" }, "n": { "type": "number", "format": "integer", "description": "Number of variations to generate (1-4).", "minimum": 1, "maximum": 4, "default": 1, "example": 1 }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "EditImagePayload": { "type": "object", "description": "Payload for editing an existing image based on text instructions", "required": [ "image" ], "properties": { "image": { "type": "string", "description": "URL or base64-encoded source image to edit.", "example": " OR data:image/png;base64,..." }, "prompt": { "type": "string", "description": "Text description of the changes to make (e.g., \"remove the background\", \"add clouds to the sky\", \"make it darker\", \"change the color scheme to warmer tones\"). Required, except with mask_mode \"erase\". With a mask, describe what should fill the masked area." }, "reference_image": { "type": "string", "description": "Optional URL or base64-encoded reference image for style or content guidance. Not used with mask_mode \"erase\".", "example": " OR data:image/png;base64,..." }, "mask": { "type": "string", "description": "Optional URL or base64-encoded PNG that limits the edit to one area of the image. White marks the area to change, black the area to keep. It must be exactly the same width and height as `image`, or the call returns 400. Without a mask the whole image is re-rendered, which can shift colours and details outside the part you meant to change. A masked edit costs more than an unmasked one (see the price).", "example": " OR data:image/png;base64,..." }, "mask_mode": { "type": "string", "enum": [ "replace", "erase" ], "description": "Only with `mask`. \"replace\" (the default) redraws the masked area from `prompt`; \"erase\" removes what is in the masked area and takes no prompt.", "example": "replace" }, "image_type": { "type": "string", "example": "sprite", "description": "What kind of image the source is (e.g. \"sprite\"). Not needed when `image` is the URL of an image you generated on Ludo in the last 30 days, which keeps its own type. Set it when the image is an upload or a link from elsewhere, so a sprite is edited as a sprite and keeps its transparent background.", "enum": [ "generic", "screenshot", "art", "asset", "sprite", "sprite-vfx", "sprite-tiling-horizontal", "sprite-tiling-vertical", "icon", "logo", "ui_asset", "fixed_background", "side_scrolling_background", "vertical_scrolling_background", "parallax_layer", "texture", "tile", "item-icon", "portrait", "card-art", "splash", "3d" ] }, "n": { "type": "number", "format": "integer", "description": "Number of edited variations to generate (1-4).", "minimum": 1, "maximum": 4, "default": 1, "example": 1 }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "AnimateSpritePayload": { "type": "object", "description": "Payload for generating an animated spritesheet from a static image. Input images can either be provided in base64 or URL. If the image was generated using Ludo, ideally it should be generated using the \"sprite\", \"sprite-vfx\" or \"ui_asset\" type.", "required": [ "motion_prompt", "initial_image" ], "properties": { "motion_prompt": { "type": "string", "description": "Text description of the desired animation, e.g. \"walking\", \"idle breathing\", \"attack slash\", \"casting a fireball with both hands\". Describe exactly and unambiguously what the character should do. Specific or complex actions are fine; there is no need to simplify them. Do not over-describe, though: too much detail can harm the animation, and an action the model already knows should be named, not decomposed into its steps (\"walking\", never \"move the left foot forward, then the right foot\"). Do not restate what initial_image already shows (the character, its appearance and equipment, the art style, the background, the lighting, the camera), and leave frame count and timing to the frames and duration fields. Negative phrasing (\"no background\", \"do not move the camera\", \"without a weapon\") works only on hydra and hydra-plus. On forge, forge-pixel and the legacy models it backfires: naming something you do not want makes it more likely to appear, so \"without a weapon\" tends to produce a weapon. On those models never phrase anything negatively; state only what should happen, and control everything else through the image and the other fields. Keep it well under 100 words: in longer prompts details start competing and some get dropped." }, "initial_image": { "type": "string", "description": "The url OR base64 of the starting frame image to animate. This is the base sprite that will be brought to life.", "example": " OR data:image/png;base64,..." }, "final_image": { "type": "string", "description": "The url OR base64 of ending frame image. When provided, the animation will interpolate between the initial and final frames.", "example": " OR data:image/png;base64,..." }, "loop": { "type": "boolean", "default": true, "description": "Trim the animation at the beginning or end to create a seamless loop. Not guaranteed to produce a perfect loop.", "example": true }, "crop": { "type": "boolean", "default": true, "description": "Crop sprite frames to fit content. Results in smaller spritesheets but inconsistent frame sizes across different animations.", "example": true }, "frames": { "type": "number", "format": "integer", "description": "Maximum number of frames in the output spritesheet. Allow about one second of duration per 16 frames - above that the model may not be able to produce them all (64 frames needs a duration of at least 4). The result can have fewer frames when the duration is short or bad frames were removed.", "default": 36, "enum": [ 4, 9, 16, 25, 36, 49, 64 ], "example": 36 }, "frame_size": { "type": "number", "format": "integer", "description": "Size of the sprite in pixels, not of the frame: it sets how big the character is drawn in the exported sheet, and each frame also holds the space around the sprite, so frames come out larger than this value. It changes the export only, not how the sprite is generated. 0 is maximum resolution. -1 is AI 1.5x upscaling. -9 is True Size: frames keep the size and position of the input frame, untrimmed, so the spritesheet lines up exactly with the input image - use it (not margin_ratio_mode \"none\") whenever the output must align with your input; it works with any margin mode. Exporting larger than the input image adds no detail: do not pick a size above the input's own resolution, and 0 or -1 gain nothing on inputs under 512 px. True Size crops at the input image's edges, so anything the animation adds beyond them (an aura, a spell effect, a swung weapon) is cut off: use a fixed size or 0 for those. adjustSpritesheet re-exports a finished animation at another size for free.", "default": 0, "enum": [ 32, 64, 96, 128, 192, 256, 384, 0, -1, -9 ], "example": 0 }, "margin_ratio": { "type": "number", "format": "float", "description": "Deprecated: prefer margin_ratio_horizontal / margin_ratio_vertical. Amount of padding around the sprite as a ratio (0.0 to 1.0). Sets both axes to this value. A per-axis value, when also given, overrides this for that axis. Supplying any margin value selects margin_ratio_mode \"manual\" unless margin_ratio_mode is set explicitly.", "deprecated": true }, "margin_ratio_horizontal": { "type": "number", "format": "float", "description": "Horizontal padding around the sprite as a ratio (0.0 to 1.0). Every bit of margin is resolution taken from the sprite, so keep it as tight as the motion allows - about 0.15 - and go higher only for motion that extends sideways (sword slashes, punches) or if the sprite gets cut off. Supplying a value selects margin_ratio_mode \"manual\" unless margin_ratio_mode is set explicitly; overrides the legacy margin_ratio on this axis." }, "margin_ratio_vertical": { "type": "number", "format": "float", "description": "Vertical padding around the sprite as a ratio (0.0 to 1.0). Every bit of margin is resolution taken from the sprite, so keep it as tight as the motion allows - about 0.15 - and go higher only for motion that extends up or down (jumps) or if the sprite gets cut off. Supplying a value selects margin_ratio_mode \"manual\" unless margin_ratio_mode is set explicitly; overrides the legacy margin_ratio on this axis." }, "margin_ratio_mode": { "type": "string", "description": "How the sprite is framed for generation. The model always generates on a canvas of the same size, so any margin is canvas the sprite does not fill: the more margin, the lower the resolution and detail of the sprite. \"auto\" (default, recommended) trims and centers the sprite and picks a margin suited to the motion. \"manual\" uses margin_ratio_horizontal / margin_ratio_vertical; keep them as tight as the motion allows (about 0.15) and raise only the axis the motion needs. \"none\" animates the input exactly as framed, with no trimming and no margin added, so the input must already have suitable margins: a sprite touching the edges gets its limbs, weapons and effects cut off as soon as it moves, and an image that is mostly empty space yields a small, low-detail sprite. \"none\" is the way to keep a deliberately off-center sprite (e.g. a character at the left edge firing a beam to the right), but results can be unpredictable. Do not use \"none\" to make the spritesheet line up with the input image - use frame_size -9 (True Size) for that; it works with any margin mode. Rules: omit margin_ratio_mode and send margin_ratio_horizontal / margin_ratio_vertical to get \"manual\" automatically; \"manual\" with no margin value fails with HTTP 400; \"auto\" or \"none\" sent together with a margin value fails with HTTP 400 (the value would be ignored).", "enum": [ "auto", "manual", "none" ], "default": "auto", "example": "auto" }, "image_type": { "type": "string", "description": "Type of sprite being animated. Affects generation parameters and styling. Tiling types (horizontal / vertical tiles, scrolling backgrounds, parallax layers, textures) stay seamless only on forge and forge-pixel, and only if the input image itself already wraps seamlessly on that axis; otherwise the animation shows a visible seam when tiled.", "default": "sprite", "enum": [ "sprite", "sprite-vfx", "item-icon", "ui_asset", "logo", "sprite-tiling-horizontal", "sprite-tiling-vertical", "parallax_layer", "tile", "texture", "portrait", "card-art" ], "example": "sprite" }, "model": { "type": "string", "description": "Model to use. Available models:\n- \"hydra\" (Hydra): 3 credits/s, shortest duration 3s, so 9 credits minimum · Most capable all-around model, generates audio\n- \"hydra-plus\" (Hydra+): 4 credits/s, shortest duration 3s, so 12 credits minimum · Hydra but with better fine details. Slower generations\n- \"forge\" (Forge): 1.5 credits/s · Sharper detail, simpler motion. Best for simple body shapes and short actions; may need a few tries\n- \"forge-pixel\" (Forge Pixel): 1.5 credits/s · Best for low-res pixel art animations\n- \"blitz\" (Blitz): 1.9 credits/s, min charge 4 credits · LEGACY - scheduled for removal, do not use for new work\n- \"eagle\" (Eagle): 2.6 credits/s, min charge 4 credits · LEGACY - scheduled for removal, do not use for new work\n- \"eagle-audio\" (Eagle with Audio): 3.1 credits/s, min charge 4 credits · LEGACY - scheduled for removal, do not use for new work\nLegacy aliases: \"standard\" → blitz.\nModels marked LEGACY still work for existing integrations but will be removed; pick a current model for anything new.\nforge-pixel expects real pixel art - a perfect pixel grid at its natural resolution; for other art use hydra or forge. Tiling image types stay seamless only on forge and forge-pixel.", "enum": [ "hydra", "hydra-plus", "forge", "forge-pixel", "blitz", "standard", "eagle", "eagle-audio" ], "default": "hydra", "example": "hydra" }, "duration": { "type": "number", "format": "float", "default": 3, "description": "Duration in seconds. Available values depend on the model:\n- hydra: 3, 3.5, 4, 4.5, 5\n- hydra-plus: 3, 3.5, 4, 4.5, 5\n- forge: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5\n- forge-pixel: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5\n- blitz: 1.2, 1.5, 2, 2.5, 3, 3.5, 4\n- eagle: 1, 2, 3, 4\n- eagle-audio: 1, 2, 3, 4", "example": 3 }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "gif": { "type": "boolean", "default": false, "description": "When true, generates an animated GIF from the spritesheet and returns it in gif_url. Disabled by default to reduce response time.", "example": false }, "individual_frames": { "type": "boolean", "default": false, "description": "When true, extracts each frame from the spritesheet as an individual image and returns the URLs in individual_frame_urls.", "example": false }, "spritesheet_with_background": { "type": "boolean", "default": false, "description": "When true, also returns the spritesheet with background intact (before background removal). Useful for manually fixing background removal issues. The with-background spritesheet URL will be in spritesheet_with_background_url.", "example": false }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "SpriteResult": { "type": "object", "properties": { "spritesheet_url": { "type": "string", "example": "" }, "video_url": { "type": "string", "example": "" }, "audio_url": { "type": "string", "description": "URL of the sound effect generated for the animation (MP3 or WAV; the extension says which). hydra and hydra-plus only; absent for forge and forge-pixel.", "example": "" }, "gif_url": { "type": "string", "example": "" }, "individual_frame_urls": { "type": "array", "items": { "type": "string", "example": "" } }, "num_frames": { "type": "integer", "description": "Number of frames in the spritesheet." }, "num_cols": { "type": "integer", "description": "Columns in the frame grid. Frames run left-to-right, top-to-bottom." }, "num_rows": { "type": "integer", "description": "Rows in the frame grid. The last row may be only partly filled." }, "spritesheet_with_background_url": { "type": "string", "example": "" }, "individual_frame_with_background_urls": { "type": "array", "items": { "type": "string", "example": "" } }, "duration": { "type": "number", "format": "float" }, "request_id": { "type": "string" }, "created_at": { "type": "integer" } } }, "AnimateSpriteKeyframesPayload": { "type": "object", "description": "Payload for generating an animated spritesheet that interpolates through up to three fixed keyframes (initial / middle / final). Runs on hydra (default), hydra-plus, forge or forge-pixel - the models supporting a middle keyframe. Input images can be provided in base64 or URL. At least one of initial_image or middle_image must be provided.", "properties": { "motion_prompt": { "type": "string", "description": "Optional text description of the desired animation, e.g. \"walking\", \"attack slash\". When omitted, the motion is derived purely from the keyframes. When provided, describe exactly and unambiguously what the character should do. Specific or complex actions are fine; there is no need to simplify them. Do not over-describe, though: too much detail can harm the animation, and an action the model already knows should be named, not decomposed into its steps (\"walking\", never \"move the left foot forward, then the right foot\"). Do not restate what the keyframes already show (the character, its appearance and equipment, the art style, the background, the lighting, the camera), and leave frame count and timing to the frames and duration fields. Negative phrasing (\"no background\", \"do not move the camera\", \"without a weapon\") works only on hydra and hydra-plus. On forge and forge-pixel it backfires: naming something you do not want makes it more likely to appear, so \"without a weapon\" tends to produce a weapon. On those models never phrase anything negatively; state only what should happen, and control everything else through the keyframes and the other fields. Keep it well under 100 words: in longer prompts details start competing and some get dropped." }, "initial_image": { "type": "string", "description": "The url OR base64 of the first keyframe. Optional when a middle_image is provided.", "example": " OR data:image/png;base64,..." }, "middle_image": { "type": "string", "description": "The url OR base64 of the middle keyframe the animation passes through between the initial and final frames. Consecutive keyframes must differ - two identical keyframes in a row produce no motion across that span.", "example": " OR data:image/png;base64,..." }, "final_image": { "type": "string", "description": "The url OR base64 of the final keyframe. Requires an initial_image or middle_image to anchor the animation.", "example": " OR data:image/png;base64,..." }, "model": { "type": "string", "description": "Model to use. Available models:\n- \"hydra\" (Hydra): 3 credits/s, shortest duration 3s, so 9 credits minimum · Most capable all-around model, generates audio\n- \"hydra-plus\" (Hydra+): 4 credits/s, shortest duration 3s, so 12 credits minimum · Hydra but with better fine details. Slower generations\n- \"forge\" (Forge): 1.5 credits/s · Sharper detail, simpler motion. Best for simple body shapes and short actions; may need a few tries\n- \"forge-pixel\" (Forge Pixel): 1.5 credits/s · Best for low-res pixel art animations\nforge-pixel expects real pixel art - a perfect pixel grid at its natural resolution; for other art use hydra or forge. Tiling image types stay seamless only on forge and forge-pixel.", "enum": [ "hydra", "hydra-plus", "forge", "forge-pixel" ], "default": "hydra", "example": "hydra" }, "loop": { "type": "boolean", "default": true, "description": "Trim the animation at the beginning or end to create a seamless loop. Not guaranteed to produce a perfect loop.", "example": true }, "crop": { "type": "boolean", "default": true, "description": "Crop sprite frames to fit content. Results in smaller spritesheets but inconsistent frame sizes across different animations.", "example": true }, "frames": { "type": "number", "format": "integer", "description": "Maximum number of frames in the output spritesheet. Allow about one second of duration per 16 frames - above that the model may not be able to produce them all (64 frames needs a duration of at least 4). The result can have fewer frames when the duration is short or bad frames were removed.", "default": 36, "enum": [ 4, 9, 16, 25, 36, 49, 64 ], "example": 36 }, "frame_size": { "type": "number", "format": "integer", "description": "Size of the sprite in pixels, not of the frame: it sets how big the character is drawn in the exported sheet, and each frame also holds the space around the sprite, so frames come out larger than this value. It changes the export only, not how the sprite is generated. 0 is maximum resolution. -1 is AI 1.5x upscaling. -9 is True Size: frames keep the size and position of the input frame, untrimmed, so the spritesheet lines up exactly with the input image - use it (not margin_ratio_mode \"none\") whenever the output must align with your input; it works with any margin mode. Exporting larger than the input image adds no detail: do not pick a size above the input's own resolution, and 0 or -1 gain nothing on inputs under 512 px. True Size crops at the input image's edges, so anything the animation adds beyond them (an aura, a spell effect, a swung weapon) is cut off: use a fixed size or 0 for those. adjustSpritesheet re-exports a finished animation at another size for free.", "default": 0, "enum": [ 32, 64, 96, 128, 192, 256, 384, 0, -1, -9 ], "example": 0 }, "margin_ratio": { "type": "number", "format": "float", "description": "Deprecated: prefer margin_ratio_horizontal / margin_ratio_vertical. Amount of padding around the sprite as a ratio (0.0 to 1.0). Sets both axes to this value. A per-axis value, when also given, overrides this for that axis. Supplying any margin value selects margin_ratio_mode \"manual\" unless margin_ratio_mode is set explicitly.", "deprecated": true }, "margin_ratio_horizontal": { "type": "number", "format": "float", "description": "Horizontal padding around the sprite as a ratio (0.0 to 1.0). Every bit of margin is resolution taken from the sprite, so keep it as tight as the motion allows - about 0.15 - and go higher only for motion that extends sideways (sword slashes, punches) or if the sprite gets cut off. Supplying a value selects margin_ratio_mode \"manual\" unless margin_ratio_mode is set explicitly; overrides the legacy margin_ratio on this axis." }, "margin_ratio_vertical": { "type": "number", "format": "float", "description": "Vertical padding around the sprite as a ratio (0.0 to 1.0). Every bit of margin is resolution taken from the sprite, so keep it as tight as the motion allows - about 0.15 - and go higher only for motion that extends up or down (jumps) or if the sprite gets cut off. Supplying a value selects margin_ratio_mode \"manual\" unless margin_ratio_mode is set explicitly; overrides the legacy margin_ratio on this axis." }, "margin_ratio_mode": { "type": "string", "description": "How the sprite is framed for generation. The model always generates on a canvas of the same size, so any margin is canvas the sprite does not fill: the more margin, the lower the resolution and detail of the sprite. \"auto\" (default, recommended) trims and centers the sprite and picks a margin suited to the motion. \"manual\" uses margin_ratio_horizontal / margin_ratio_vertical; keep them as tight as the motion allows (about 0.15) and raise only the axis the motion needs. \"none\" animates the input exactly as framed, with no trimming and no margin added, so the input must already have suitable margins: a sprite touching the edges gets its limbs, weapons and effects cut off as soon as it moves, and an image that is mostly empty space yields a small, low-detail sprite. \"none\" is the way to keep a deliberately off-center sprite (e.g. a character at the left edge firing a beam to the right), but results can be unpredictable. Do not use \"none\" to make the spritesheet line up with the input image - use frame_size -9 (True Size) for that; it works with any margin mode. Rules: omit margin_ratio_mode and send margin_ratio_horizontal / margin_ratio_vertical to get \"manual\" automatically; \"manual\" with no margin value fails with HTTP 400; \"auto\" or \"none\" sent together with a margin value fails with HTTP 400 (the value would be ignored).", "enum": [ "auto", "manual", "none" ], "default": "auto", "example": "auto" }, "image_type": { "type": "string", "description": "Type of sprite being animated. Affects generation parameters and styling. Tiling types (horizontal / vertical tiles, scrolling backgrounds, parallax layers, textures) stay seamless only on forge and forge-pixel, and only if the input image itself already wraps seamlessly on that axis; otherwise the animation shows a visible seam when tiled.", "default": "sprite", "enum": [ "sprite", "sprite-vfx", "item-icon", "ui_asset", "logo", "sprite-tiling-horizontal", "sprite-tiling-vertical", "parallax_layer", "tile", "texture", "portrait", "card-art" ], "example": "sprite" }, "duration": { "type": "number", "format": "float", "default": 3, "description": "Duration in seconds. Available values depend on the model:\n- hydra: 3, 3.5, 4, 4.5, 5\n- hydra-plus: 3, 3.5, 4, 4.5, 5\n- forge: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5\n- forge-pixel: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5", "example": 3 }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "gif": { "type": "boolean", "default": false, "description": "When true, generates an animated GIF from the spritesheet and returns it in gif_url. Disabled by default to reduce response time.", "example": false }, "individual_frames": { "type": "boolean", "default": false, "description": "When true, extracts each frame from the spritesheet as an individual image and returns the URLs in individual_frame_urls.", "example": false }, "spritesheet_with_background": { "type": "boolean", "default": false, "description": "When true, also returns the spritesheet with background intact (before background removal). Useful for manually fixing background removal issues. The with-background spritesheet URL will be in spritesheet_with_background_url.", "example": false }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "GeneratePosePayload": { "type": "object", "description": "Payload for generating a new pose for an existing sprite", "required": [ "image", "pose" ], "properties": { "image": { "type": "string", "description": "URL or base64-encoded source sprite image to generate a new pose from.", "example": " OR data:image/png;base64,..." }, "pose": { "type": "string", "description": "Target pose for the sprite. Use the value \"Other\" to generate other poses not listed in the accepted values, and fill the field description accordingly.", "enum": [ "Idle (Front)", "Idle (Back)", "Idle (Left Facing)", "Idle (Right Facing)", "Walk (Left)", "Walk (Right)", "Walk (Towards the camera)", "Walk (Away from the camera)", "Run (Left)", "Run (Right)", "Run (Towards the camera)", "Run (Away from the camera)", "Crouching", "Crawling", "Sitting", "Defending / Blocking", "Attack Ready", "Jump Preparation", "Sleeping", "Flying", "Other" ], "example": "Idle (Front)" }, "description": { "type": "string", "description": "Optional additional instructions or description to guide the pose generation." }, "n": { "type": "number", "format": "integer", "description": "Number of pose variations to generate (1-4).", "minimum": 1, "maximum": 4, "default": 1, "example": 1 }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "PoseResult": { "type": "object", "description": "Result of a pose generation", "properties": { "url": { "type": "string", "description": "URL of the generated pose image", "example": "" }, "pose": { "type": "string", "description": "The pose that was used to generate this image" }, "description": { "type": "string", "description": "The pose description that was used to generate this image" }, "motion_prompt": { "type": "string", "description": "A suggested motion prompt optimized for this pose. Can be used directly with 'animateSprite' for best animation results." } } }, "RotateSpritePayload": { "type": "object", "description": "Payload for rotating the camera view of an existing sprite", "required": [ "image", "camera_rotation" ], "properties": { "image": { "type": "string", "description": "URL or base64-encoded source sprite image to rotate.", "example": " OR data:image/png;base64,..." }, "camera_rotation": { "type": "integer", "enum": [ 0, 45, 90, 135, 180, -135, -90, -45 ], "description": "Camera azimuth angle in degrees. 0 = front, 45 = front-right, 90 = right side, 135 = back-right, 180 = back, -135 = back-left, -90 = left side, -45 = front-left.", "example": 0 }, "camera_elevation": { "type": "integer", "enum": [ 0, 30, 60 ], "description": "Optional camera elevation/tilt in degrees. 0 = eye-level, 30 = elevated, 60 = high-angle. Omit to keep the sprite's current elevation.", "example": 0 }, "n": { "type": "number", "format": "integer", "description": "Number of variations to generate (1-4).", "minimum": 1, "maximum": 4, "default": 1, "example": 1 }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "RotateSpriteResult": { "type": "object", "description": "Result of a sprite camera rotation", "properties": { "url": { "type": "string", "description": "URL of the generated image", "example": "" }, "camera_rotation": { "type": "integer", "description": "The camera azimuth angle that was applied" }, "camera_elevation": { "type": "integer", "description": "The camera elevation that was applied, if any" } } }, "TransferMotionPayload": { "type": "object", "description": "Payload for transferring motion from a video onto a static sprite image, producing an animated spritesheet.", "required": [ "image" ], "properties": { "image": { "type": "string", "description": "The static sprite to animate, as a URL or base64 image. Ideally an image generated with the \"sprite\", \"sprite-vfx\" or \"ui_asset\" image type.", "example": " OR data:image/png;base64,..." }, "video": { "type": "string", "description": "URL of the video to use as motion source - the `video_url` of a spritesheet from animateSprite, or your own clip. Videos up to 4 seconds work best. Either `video` or `preset_id` + `perspective` + `direction` must be provided; when both are sent the video is used. A video more than twice as long as `duration` gets heavily compressed and the motion turns rushed - trim it to the part you want, or raise `duration`." }, "preset_id": { "type": "string", "description": "ID of an animation preset to use instead of a video URL. Use listAnimationPresets to list available presets. When using a preset, `perspective` and `direction` are required." }, "direction": { "type": "string", "description": "Direction for the animation preset. When using a preset, `direction` is required.", "enum": [ "N", "NE", "E", "SE", "S", "SW", "W", "NW" ], "example": "N" }, "perspective": { "type": "string", "description": "Camera perspective of the preset clip, by id (the `perspectives` list of listAnimationPresets, the same set for every preset): high = tactical steep top-down, horizon = side view at eye level, isometric = diagonal top-down with depth, low = hero low angle, top = directly overhead. Required when using a preset. Unrelated to the `perspective` of createImage, which is a free-text art direction.", "enum": [ "high", "horizon", "isometric", "low", "top" ], "example": "high" }, "frames": { "type": "number", "format": "integer", "description": "Maximum number of frames in the output spritesheet. Allow about one second of duration per 16 frames - above that the model may not be able to produce them all (64 frames needs a duration of at least 4). The result can have fewer frames when the duration is short or bad frames were removed.", "default": 36, "enum": [ 4, 9, 16, 25, 36, 49, 64 ], "example": 36 }, "frame_size": { "type": "number", "format": "integer", "description": "Size of the sprite in pixels, not of the frame: it sets how big the character is drawn in the exported sheet, and each frame also holds the space around the sprite, so frames come out larger than this value. 0 is maximum resolution. Exporting larger than the input image adds no detail: do not pick a size above the input's own resolution, and 0 gains nothing on inputs under 512 px. True Size is not available here: the image is not the first frame of the result, so there is nothing to align to.", "default": 0, "enum": [ 32, 64, 96, 128, 192, 256, 384, 0 ], "example": 0 }, "loop": { "type": "boolean", "default": true, "description": "Trim the animation at the beginning or end to create a seamless loop.", "example": true }, "crop": { "type": "boolean", "default": true, "description": "Crop sprite frames to fit content. Results in smaller spritesheets but inconsistent frame sizes across different animations.", "example": true }, "margin_ratio": { "type": "number", "format": "float", "description": "Deprecated: prefer margin_ratio_horizontal / margin_ratio_vertical. Amount of padding around the sprite as a ratio (0.0 to 1.0). Sets both axes to this value. A per-axis value, when also given, overrides this for that axis. Defaults to 0.15 when no margin value is given at all.", "deprecated": true }, "margin_ratio_horizontal": { "type": "number", "format": "float", "description": "Horizontal padding around the sprite as a ratio (0.0 to 1.0). Every bit of margin is resolution taken from the sprite, so keep it as tight as the motion allows - about 0.15 - and go higher only for motion that extends sideways (sword slashes, punches) or if the sprite gets cut off. Overrides the legacy margin_ratio on this axis." }, "margin_ratio_vertical": { "type": "number", "format": "float", "description": "Vertical padding around the sprite as a ratio (0.0 to 1.0). Every bit of margin is resolution taken from the sprite, so keep it as tight as the motion allows - about 0.15 - and go higher only for motion that extends up or down (jumps) or if the sprite gets cut off. Overrides the legacy margin_ratio on this axis." }, "margin_ratio_mode": { "type": "string", "description": "How the sprite is framed for generation. Defaults to \"manual\" (0.15 on each axis when no margin value is given); transfer motion has no \"auto\". The model always generates on a canvas of the same size, so any margin is canvas the sprite does not fill: the more margin, the lower the resolution and detail of the sprite. Keep the margins tight - about 0.15 - and raise only the axis the motion needs. \"none\" animates the image exactly as framed, so it must already have suitable margins (not touching the edges, not mostly empty space); an off-center sprite can give unpredictable results. Sending \"none\" together with a margin value fails with HTTP 400 (the value would be ignored).", "enum": [ "manual", "none" ], "default": "manual", "example": "manual" }, "gif": { "type": "boolean", "default": false, "description": "When true, generates an animated GIF from the spritesheet and returns it in gif_url. Disabled by default to reduce response time.", "example": false }, "individual_frames": { "type": "boolean", "default": false, "description": "When true, extracts each frame from the spritesheet as an individual image and returns the URLs in individual_frame_urls.", "example": false }, "spritesheet_with_background": { "type": "boolean", "default": false, "description": "When true, also returns the spritesheet with background intact (before background removal). Useful for manually fixing background removal issues. The with-background spritesheet URL will be in spritesheet_with_background_url.", "example": false }, "model": { "type": "string", "description": "Model to use. Available models:\n- \"hydra\" (Hydra): 3 credits/s · Most capable all-around model, generates audio\n- \"forge\" (Forge): 2 credits/s · Sharper detail, simpler motion. Best for simple body shapes and short actions; may need a few tries\n- \"forge-pixel\" (Forge Pixel): 2 credits/s · Best for low-res pixel art animations\n- \"tango\" (Tango): 4 credits/s, min charge 4 credits · LEGACY - scheduled for removal, do not use for new work\nModels marked LEGACY still work for existing integrations but will be removed; pick a current model for anything new.\nforge is tuned for the motion presets (preset_id) and often fails to follow your own video - use hydra for custom footage. forge-pixel expects real pixel art - a perfect pixel grid at its natural resolution.", "enum": [ "hydra", "forge", "forge-pixel", "tango" ], "default": "hydra", "example": "hydra" }, "prompt": { "type": "string", "description": "Optional extra instructions for the motion transfer (e.g. \"keep the cape still\"), added to the model's own prompt." }, "duration": { "type": "number", "format": "float", "default": 1.5, "description": "Duration in seconds. If the reference video is longer, it will be compressed to this duration. Available values depend on the model:\n- hydra: 3, 3.5, 4, 4.5, 5\n- forge: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5\n- forge-pixel: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5\n- tango: 1, 1.5, 2, 2.5, 3, 3.5, 4", "example": 1.5 }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "DocumentationResponse": { "type": "object", "properties": { "models": { "$ref": "#/components/schemas/ModelLineup" }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentationEntry" } }, "unmatched_sections": { "type": "array", "description": "Requested section titles that matched no section of `doc`. Present only when some, but not all, requested titles matched.", "items": { "type": "string" } }, "available_sections": { "type": "array", "description": "Every section title of `doc`, for correcting the titles in `unmatched_sections`. Present only alongside `unmatched_sections`.", "items": { "type": "string" } } } }, "DocumentationSearchResponse": { "type": "object", "properties": { "results": { "type": "array", "description": "Matching documentation sections, best first. Empty when nothing matches closely.", "items": { "$ref": "#/components/schemas/DocumentationSearchResult" } }, "message": { "type": "string", "description": "Present only when `results` is empty: what to try next." } } }, "AnimationPresetsResponse": { "type": "object", "properties": { "animations": { "type": "array", "items": { "$ref": "#/components/schemas/AnimationPresetPublic" } }, "perspectives": { "type": "array", "items": { "$ref": "#/components/schemas/AnimationPerspective" } }, "directions": { "type": "array", "items": { "type": "string" } } } }, "EditSpritesheetPayloadPublic": { "type": "object", "description": "Payload for editing a previously generated spritesheet. edit_mode selects the operation - prompt-driven edit (default), outpaint, loop fixing, or improve (finer detail, on hydra spritesheets only).", "required": [ "spritesheet_url" ], "properties": { "spritesheet_url": { "type": "string", "description": "URL of a spritesheet you generated in the last 7 days (returned by animateSprite, transferMotion, or a previous edit as spritesheet_url). External URLs are not accepted. Edit the original animation rather than a previous edit's result: every edit re-renders the whole animation, so colors and detail drift further with each pass. If an edit did not work, retry from the original instead of editing on top.", "example": "" }, "edit_mode": { "type": "string", "description": "Edit operation to perform. \"improve\" re-renders the animation with finer detail (the extra pass hydra-plus runs when it generates) and only takes a spritesheet generated with hydra; any other source returns HTTP 400, including an already improved spritesheet (or a loop fix or outpaint of one), which has that detail already.", "enum": [ "prompt", "outpaint", "fix_loop", "improve" ], "default": "prompt", "example": "prompt" }, "prompt": { "type": "string", "description": "Edit instruction. Required for edit_mode \"prompt\", optional for \"outpaint\", not accepted for \"fix_loop\" or \"improve\". Focus it on a single change and keep it short (under about 50 words); run a second edit for more." }, "images": { "type": "array", "maxItems": 5, "items": { "type": "string" }, "description": "Optional reference images (up to 5), each a URL or base64, to guide the edit. Two, at most three, work best: more references reduce the model's ability to use any of them correctly." }, "duration": { "type": "number", "format": "float", "description": "Duration in seconds. Available values depend on the model:\n- hydra: 3, 3.5, 4, 4.5, 5\n- forge: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5\n- forge-pixel: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5" }, "model": { "type": "string", "description": "Model to use. Available models:\n- \"hydra\" (Hydra): 3 credits/s · Most capable all-around model, generates audio\n- \"forge\" (Forge): 2 credits/s · Sharper detail, simpler motion. Best for simple body shapes and short actions; may need a few tries\n- \"forge-pixel\" (Forge Pixel): 2 credits/s · Best for low-res pixel art animations", "enum": [ "hydra", "forge", "forge-pixel" ], "default": "hydra" }, "crop": { "type": "boolean", "description": "Crop sprite frames to fit content (omit to keep the source spritesheet's setting). Results in smaller spritesheets but inconsistent frame sizes across different animations." }, "loop": { "type": "boolean", "default": true, "description": "Trim the animation at the beginning or end to create a seamless loop." }, "frames": { "type": "number", "format": "integer", "description": "Number of frames in the output spritesheet. Omit to keep the source spritesheet's frame count. Allow about one second of duration per 16 frames - above that the model may not be able to produce them all.", "enum": [ 4, 9, 16, 25, 36, 49, 64 ] }, "frame_size": { "type": "number", "format": "integer", "description": "Size of the sprite in pixels, not of the frame - it sets how big the character is drawn, and each frame also holds the space around it, so frames come out larger than this value. 0 is for maximum resolution. Omit to keep the source spritesheet's setting.", "enum": [ 32, 64, 96, 128, 192, 256, 384, 0 ] }, "gif": { "type": "boolean", "default": false, "description": "When true, generates an animated GIF from the spritesheet and returns it in gif_url. Disabled by default to reduce response time.", "example": false }, "individual_frames": { "type": "boolean", "default": false, "description": "When true, extracts each frame from the spritesheet as an individual image and returns the URLs in individual_frame_urls.", "example": false }, "spritesheet_with_background": { "type": "boolean", "default": false, "description": "When true, also returns the spritesheet with background intact (before background removal). The with-background spritesheet URL will be in spritesheet_with_background_url.", "example": false }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "RotateSpritesheetPayload": { "type": "object", "description": "Payload for re-rendering a previously generated sprite animation from a new view.", "required": [ "spritesheet_url", "image" ], "properties": { "spritesheet_url": { "type": "string", "description": "URL of a spritesheet you generated in the last 7 days (returned by animateSprite, animateSpriteKeyframes, transferMotion or editSpritesheet as spritesheet_url). External URLs are not accepted.", "example": "" }, "image": { "type": "string", "description": "The character exactly as it must appear in the new view, as a URL or base64. It becomes the first frame of the animation. rotateSprite produces one from the animation's first frame.", "example": " OR data:image/png;base64,..." }, "final_image": { "type": "string", "description": "Optional exact last frame (URL or base64). Defaults to the first frame, for cyclic or returning animations." }, "prompt": { "type": "string", "description": "Optional instructions - the character's facing in the new view (\"its back to the camera\"), where the action goes (\"the kick goes to the left of the frame\"), or anything else about the motion." }, "duration": { "type": "number", "format": "float", "minimum": 1, "maximum": 5, "description": "Duration in seconds. Available values depend on the model:\n- hydra: 3, 3.5, 4, 4.5, 5\n- hydra-plus: 3, 3.5, 4, 4.5, 5" }, "model": { "type": "string", "description": "Model to use. Available models:\n- \"hydra\" (Hydra): 3 credits/s, shortest duration 3s, so 9 credits minimum · Most capable all-around model, generates audio\n- \"hydra-plus\" (Hydra+): 4 credits/s, shortest duration 3s, so 12 credits minimum · Hydra but with better fine details. Slower generations", "enum": [ "hydra", "hydra-plus" ], "default": "hydra" }, "loop": { "type": "boolean", "description": "Trim the animation at the beginning or end to create a seamless loop. Omit to keep the source spritesheet's setting." }, "crop": { "type": "boolean", "default": true, "description": "Crop sprite frames to fit content. Results in smaller spritesheets but inconsistent frame sizes across different animations." }, "frames": { "type": "number", "format": "integer", "description": "Number of frames in the output spritesheet. Omit to keep the source spritesheet's frame count. Allow about one second of duration per 16 frames - above that the model may not be able to produce them all.", "enum": [ 4, 9, 16, 25, 36, 49, 64 ] }, "frame_size": { "type": "number", "format": "integer", "description": "Size of the sprite in pixels, not of the frame - it sets how big the character is drawn, and each frame also holds the space around it, so frames come out larger than this value. 0 is for maximum resolution. Omit to keep the source spritesheet's setting.", "enum": [ 32, 64, 96, 128, 192, 256, 384, 0 ] }, "gif": { "type": "boolean", "default": false, "description": "When true, generates an animated GIF from the spritesheet and returns it in gif_url. Disabled by default to reduce response time.", "example": false }, "individual_frames": { "type": "boolean", "default": false, "description": "When true, extracts each frame from the spritesheet as an individual image and returns the URLs in individual_frame_urls.", "example": false }, "spritesheet_with_background": { "type": "boolean", "default": false, "description": "When true, also returns the spritesheet with background intact (before background removal). The with-background spritesheet URL will be in spritesheet_with_background_url.", "example": false }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "AdjustSpritesheetPayload": { "type": "object", "description": "Payload for re-exporting a previously generated sprite animation with different sheet settings (Adjust Sprite Sheet in the web app).", "required": [ "spritesheet_url" ], "properties": { "spritesheet_url": { "type": "string", "description": "URL of a spritesheet you generated through the API in the last 7 days (the spritesheet_url returned by animateSprite, animateSpriteKeyframes, transferMotion, editSpritesheet, rotateSpritesheet or adjustSpritesheet). External URLs are not accepted.", "example": "" }, "frames": { "type": "number", "format": "integer", "description": "Number of frames in the new sheet. Omit to keep the source's frame count.", "enum": [ 4, 9, 16, 25, 36, 49, 64 ] }, "frame_size": { "type": "number", "format": "integer", "description": "Size of the sprite in pixels, not of the frame: it sets how big the character is drawn, and each frame also holds the space around it, so frames come out larger than this value. Omit to keep the source's setting. 0 is maximum resolution. -1 is AI 1.5x upscaling, which gains nothing on sources under 512 px. -9 is True Size: frames keep the size and position of the source's input image, so anything the animation adds beyond its edges is cut off - pick a fixed size or 0 to get it back.", "enum": [ 32, 64, 96, 128, 192, 256, 384, 0, -1, -9 ] }, "loop": { "type": "boolean", "description": "Trim the animation at the beginning or end to create a seamless loop. Omit to keep the source's setting." }, "crop": { "type": "boolean", "description": "Crop frames to fit their content. Results in smaller spritesheets but inconsistent frame sizes across different animations. Omit to keep the source's setting. Ignored with True Size, which never crops." }, "gif": { "type": "boolean", "default": false, "description": "When true, generates an animated GIF from the spritesheet and returns it in gif_url. Disabled by default to reduce response time.", "example": false }, "individual_frames": { "type": "boolean", "default": false, "description": "When true, extracts each frame from the spritesheet as an individual image and returns the URLs in individual_frame_urls.", "example": false }, "spritesheet_with_background": { "type": "boolean", "default": false, "description": "When true, also returns the spritesheet with background intact (before background removal). The with-background spritesheet URL will be in spritesheet_with_background_url.", "example": false }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "CreateSpriteAudioPayload": { "type": "object", "description": "Payload for generating audio for a previously generated spritesheet animation.", "required": [ "spritesheet_video_url" ], "properties": { "spritesheet_video_url": { "type": "string", "description": "The video_url of a spritesheet you generated in the last 7 days (returned by animateSprite, animateSpriteKeyframes, transferMotion, or editSpritesheet). External URLs are not accepted.", "example": "" }, "prompt": { "type": "string", "description": "Optional description of the sound to generate." }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. It does not re-tag the spritesheet, which keeps the request_id it was generated with." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "AudioResult": { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the generated audio file: MP3 or WAV; the extension (.mp3 or .wav) says which.", "example": "" }, "type": { "type": "string" }, "duration": { "type": "number", "format": "float" }, "request_id": { "type": "string" }, "created_at": { "type": "integer" } } }, "DirectionalSpriteStylesResponse": { "type": "object", "properties": { "styles": { "type": "array", "items": { "$ref": "#/components/schemas/DirectionalSpriteStyle" } }, "perspectives": { "type": "array", "items": { "type": "string" } }, "directions": { "type": "array", "items": { "type": "string" } } } }, "DirectionalPreviewPayload": { "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "description": "The 3D model, as a URL or base64-encoded GLB file (not an AI model name). Rigged, to animate it.", "example": " OR data:model/gltf-binary;base64,..." }, "animation_url": { "type": "string", "description": "An animation for the model, as a URL or base64-encoded GLB file - the glb_url of an animation from animate3DModel or animate3DModelPreset, made for this model's skeleton. At most one of animation_url, preset_id and model_animation.", "example": " OR data:model/gltf-binary;base64,..." }, "preset_id": { "type": "string", "description": "An animation preset id from listAnimationPresets, retargeted onto the model. Any rig type can take one; when the preset cannot be retargeted onto the model, the call returns an error. At most one of animation_url, preset_id and model_animation." }, "crop_loop": { "type": "boolean", "description": "With preset_id, trim the preset to the span that loops seamlessly. Omit to follow the preset's own loop flag." }, "model_animation": { "type": "string", "description": "The name of an animation the GLB itself carries. At most one of animation_url, preset_id and model_animation; with none, the preview is a single frame." }, "perspective": { "type": "string", "default": "isometric", "description": "Camera height, from the side (horizon) to straight down (top).", "enum": [ "horizon", "low", "isometric", "high", "top" ], "example": "isometric" }, "directions": { "type": "array", "default": [ "SW" ], "minItems": 1, "maxItems": 8, "uniqueItems": true, "description": "Where the camera stands around a character facing S, each direction at most once. One preview per direction, in this order.", "items": { "type": "string", "enum": [ "S", "SW", "W", "NW", "N", "NE", "E", "SE" ], "example": "S" }, "example": [ "SW" ] }, "style_id": { "type": "string", "default": "render_3d", "description": "A style id from listDirectionalSpriteStyles.", "example": "render_3d" }, "style_version": { "type": "integer", "description": "Version of the style; omit for its current one." }, "style_params": { "type": "object", "description": "The style's settings to change, by name, each one of its listed option values (true/false for a bool setting, or any colour for a color one). Omit a setting to keep its default." }, "keep_horizontal_travel": { "type": "boolean", "default": false, "description": "Keep the animation's ground travel (the character moves across the frame). Off keeps it in place.", "example": false }, "keep_vertical_travel": { "type": "boolean", "default": true, "description": "Keep the animation's vertical root motion (jumps, bobbing).", "example": true }, "target_frame_size": { "type": "integer", "minimum": 32, "maximum": 384, "default": 256, "description": "Sprite size of the preview frames in pixels (the longer side).", "example": 256 } } }, "DirectionalPreviewResult": { "type": "object", "properties": { "previews": { "type": "array", "description": "One preview per direction, in the order asked.", "items": { "$ref": "#/components/schemas/DirectionalPreview" } } } }, "DirectionalSpritesPayload": { "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "description": "The 3D model, as a URL or base64-encoded GLB file (not an AI model name). Rigged, to animate it.", "example": " OR data:model/gltf-binary;base64,..." }, "animation_url": { "type": "string", "description": "An animation for the model, as a URL or base64-encoded GLB file - the glb_url of an animation from animate3DModel or animate3DModelPreset, made for this model's skeleton. At most one of animation_url, preset_id and model_animation.", "example": " OR data:model/gltf-binary;base64,..." }, "preset_id": { "type": "string", "description": "An animation preset id from listAnimationPresets, retargeted onto the model. Any rig type can take one; when the preset cannot be retargeted onto the model, the call returns an error. At most one of animation_url, preset_id and model_animation." }, "crop_loop": { "type": "boolean", "description": "With preset_id, trim the preset to the span that loops seamlessly. Omit to follow the preset's own loop flag." }, "model_animation": { "type": "string", "description": "The name of an animation the GLB itself carries. At most one of animation_url, preset_id and model_animation; with none, each sheet is a single frame." }, "perspective": { "type": "string", "default": "isometric", "description": "Camera height, from the side (horizon) to straight down (top).", "enum": [ "horizon", "low", "isometric", "high", "top" ], "example": "isometric" }, "directions": { "type": "array", "default": [ "SW" ], "minItems": 1, "maxItems": 8, "uniqueItems": true, "description": "Where the camera stands around a character facing S, each direction at most once. One sheet per direction, in this order, rendered together on the same frame size, scale and floor so they line up.", "items": { "type": "string", "enum": [ "S", "SW", "W", "NW", "N", "NE", "E", "SE" ], "example": "S" }, "example": [ "SW" ] }, "style_id": { "type": "string", "default": "render_3d", "description": "A style id from listDirectionalSpriteStyles.", "example": "render_3d" }, "style_version": { "type": "integer", "description": "Version of the style; omit for its current one. A render_3d from an earlier result names the version it was rendered with." }, "style_params": { "type": "object", "description": "The style's settings to change, by name, each one of its listed option values (true/false for a bool setting, or any colour for a color one). Omit a setting to keep its default." }, "keep_horizontal_travel": { "type": "boolean", "default": false, "description": "Keep the animation's ground travel (the character moves across the frame). Off keeps it in place.", "example": false }, "keep_vertical_travel": { "type": "boolean", "default": true, "description": "Keep the animation's vertical root motion (jumps, bobbing).", "example": true }, "target_frame_size": { "type": "integer", "minimum": 32, "maximum": 640, "default": 640, "description": "Sprite size in pixels - the longer side of the frame, which every direction shares.", "example": 640 }, "num_frames": { "type": "integer", "minimum": 4, "maximum": 100, "default": 36, "description": "Frames per sheet, sampled over the animation; moved to the nearest count that fills the sheet grid, and never more than the animation's keyframes. A still model gives one.", "example": 36 }, "loop": { "type": "boolean", "description": "Sample the animation as a seamless loop. Omit to follow the animation's own loop flag." }, "gif": { "type": "boolean", "default": false, "description": "Also return each sheet as an animated GIF (gif_url).", "example": false }, "individual_frames": { "type": "boolean", "default": false, "description": "Also return each sheet's frames as separate images (individual_frame_urls).", "example": false }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "DirectionalSpritesResult": { "type": "object", "properties": { "sheets": { "type": "array", "description": "One sheet per direction, in the order asked.", "items": { "$ref": "#/components/schemas/DirectionalSpriteSheet" } } } }, "DirectionalStillsPayload": { "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "description": "The 3D model, as a URL or base64-encoded GLB file (not an AI model name). Rendered as it is, in its rest pose.", "example": " OR data:model/gltf-binary;base64,..." }, "perspective": { "type": "string", "default": "isometric", "description": "Camera height, from the side (horizon) to straight down (top).", "enum": [ "horizon", "low", "isometric", "high", "top" ], "example": "isometric" }, "directions": { "type": "array", "default": [ "SW" ], "minItems": 1, "maxItems": 8, "uniqueItems": true, "description": "Where the camera stands around a character facing S, each direction at most once. One image per direction, in this order, rendered together so they line up.", "items": { "type": "string", "enum": [ "S", "SW", "W", "NW", "N", "NE", "E", "SE" ], "example": "S" }, "example": [ "SW" ] }, "style_id": { "type": "string", "default": "render_3d", "description": "A style id from listDirectionalSpriteStyles.", "example": "render_3d" }, "style_version": { "type": "integer", "description": "Version of the style; omit for its current one." }, "style_params": { "type": "object", "description": "The style's settings to change, by name, each one of its listed option values (true/false for a bool setting, or any colour for a color one). Omit a setting to keep its default." }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "DirectionalStillsResult": { "type": "object", "properties": { "images": { "type": "array", "description": "One image per direction, in the order asked.", "items": { "$ref": "#/components/schemas/DirectionalStill" } } } }, "GenerateVideoPayloadPublic": { "type": "object", "description": "Payload for generating a video from a source image and motion prompt", "required": [ "image", "prompt" ], "properties": { "image": { "type": "string", "description": "URL or base64-encoded source image (the starting frame for the video)", "example": " OR data:image/png;base64,..." }, "prompt": { "type": "string", "description": "Text description of the motion or action for the video (e.g., \"walking forward\", \"waving hand\", \"camera zoom in\")" }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "final_image": { "type": "string", "description": "URL or base64-encoded end frame image. When provided, the video will interpolate between the initial and final frames.", "example": " OR data:image/png;base64,..." }, "duration": { "type": "number", "format": "float", "default": 5, "description": "Duration in seconds. Available values depend on the model:\n- griffin: 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15\n- griffin-hd: 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15\n- blitz: 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12\n- eagle: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15\n- eagle-audio: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15", "example": 5 }, "model": { "type": "string", "description": "Model to use. Available models:\n- \"griffin\" (Griffin): 1.5 credits/s, shortest duration 5s, so 7.5 credits minimum · Fast cinematic videos in any style, with audio, 480p\n- \"griffin-hd\" (Griffin HD): 2 credits/s, shortest duration 5s, so 10 credits minimum · Same as Griffin, but in 720p\n- \"blitz\" (Blitz): 1 credits/s, shortest duration 2s, so 2 credits minimum · LEGACY - scheduled for removal, do not use for new work\n- \"eagle\" (Eagle): 1.3 credits/s · LEGACY - scheduled for removal, do not use for new work\n- \"eagle-audio\" (Eagle with Audio): 1.8 credits/s · LEGACY - scheduled for removal, do not use for new work\nLegacy aliases: \"standard\" → blitz.\nModels marked LEGACY still work for existing integrations but will be removed; pick a current model for anything new.", "enum": [ "griffin", "griffin-hd", "blitz", "standard", "eagle", "eagle-audio" ], "default": "griffin", "example": "griffin" }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "VideoResult": { "type": "object", "properties": { "url": { "type": "string", "description": "URL to the generated video file", "example": "" }, "duration": { "type": "number", "format": "float", "description": "Duration of the video in seconds" }, "has_audio": { "type": "boolean" }, "request_id": { "type": "string" }, "created_at": { "type": "integer" } } }, "ReferencesToVideoPayloadPublic": { "type": "object", "description": "Payload for generating a video from 1-5 reference images and a text prompt.", "required": [ "prompt", "images" ], "properties": { "prompt": { "type": "string", "description": "Text description of the video to generate." }, "images": { "type": "array", "minItems": 1, "maxItems": 5, "items": { "type": "string" }, "description": "Reference images (1 to 5), each a URL or base64. The generated video borrows characters, objects, and style from them." }, "duration": { "type": "number", "format": "float", "default": 5, "description": "Duration in seconds. Available values depend on the model:\n- griffin: 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15\n- griffin-hd: 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15\n- eagle: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15\n- eagle-audio: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15", "example": 5 }, "model": { "type": "string", "description": "Model to use. Available models:\n- \"griffin\" (Griffin): 2.5 credits/s, shortest duration 5s, so 12.5 credits minimum · Fast cinematic videos in any style, with audio, 480p\n- \"griffin-hd\" (Griffin HD): 4 credits/s, shortest duration 5s, so 20 credits minimum · Same as Griffin, but in 720p\n- \"eagle\" (Eagle): 1.5 credits/s · LEGACY - scheduled for removal, do not use for new work\n- \"eagle-audio\" (Eagle with Audio): 2 credits/s · LEGACY - scheduled for removal, do not use for new work\nModels marked LEGACY still work for existing integrations but will be removed; pick a current model for anything new.", "enum": [ "griffin", "griffin-hd", "eagle", "eagle-audio" ], "default": "griffin", "example": "griffin" }, "aspect_ratio": { "type": "string", "description": "Output aspect ratio. \"default\" lets the model choose.", "enum": [ "default", "ar_1_1", "ar_16_9", "ar_9_16", "ar_4_3", "ar_3_4", "ar_21_9" ], "default": "default", "example": "default" }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "EditVideoPayloadPublic": { "type": "object", "description": "Payload for editing a previously generated video with a text prompt and optional reference images.", "required": [ "prompt", "video" ], "properties": { "video": { "type": "string", "description": "URL of a video you generated in the last 7 days (returned by createVideo, createVideoFromReferences, or a previous edit). External URLs are not accepted." }, "prompt": { "type": "string", "description": "Edit instruction describing the desired change." }, "images": { "type": "array", "maxItems": 5, "items": { "type": "string" }, "description": "Optional reference images (up to 5), each a URL or base64, to guide the edit." }, "duration": { "type": "number", "format": "float", "description": "Duration in seconds. Available values depend on the model:\n- griffin-hd: 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15\n- eagle: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15" }, "model": { "type": "string", "description": "Model to use. Available models:\n- \"griffin-hd\" (Griffin HD): 2 credits/s · Same as Griffin, but in 720p\n- \"eagle\" (Eagle): 2 credits/s · LEGACY - scheduled for removal, do not use for new work\nModels marked LEGACY still work for existing integrations but will be removed; pick a current model for anything new.", "enum": [ "griffin-hd", "eagle" ], "default": "griffin-hd", "example": "griffin-hd" }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "UpscaleVideoPayloadPublic": { "type": "object", "description": "Payload for upscaling a previously generated video to twice its resolution.", "required": [ "video" ], "properties": { "video": { "type": "string", "description": "URL of a video you generated in the last 7 days (returned by createVideo, createVideoFromReferences, or editVideo). External URLs are not accepted. Both dimensions must be under 960 pixels (griffin 480p output qualifies; griffin-hd 720p output does not, except square)." }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "RemoveBackgroundPayload": { "type": "object", "description": "Payload for removing the background of an image", "required": [ "image" ], "properties": { "image": { "type": "string", "description": "URL or base64-encoded image to remove the background from.", "example": " OR data:image/png;base64,..." }, "crop": { "type": "boolean", "default": false, "description": "Whether to crop/trim the result to fit the content.", "example": false }, "creative_edit": { "type": "boolean", "default": true, "description": "Higher quality results but the image will not be exactly the same as the input.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "UpscaleImagePayload": { "type": "object", "description": "Payload for upscaling an image", "required": [ "image" ], "properties": { "image": { "type": "string", "description": "URL or base64-encoded image to upscale, below 2048px on its longest side.", "example": " OR data:image/png;base64,..." }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "Create3DModelPayload": { "type": "object", "required": [ "image" ], "properties": { "image": { "type": "string", "description": "URL or base64-encoded image to convert to 3D, taken as the front view of the subject", "example": " OR data:image/png;base64,..." }, "model": { "type": "string", "default": "prop", "description": "Model to use. Available models:\n- \"prop\" (Prop): 4 credits · Low-cost, good for everyday props and environment pieces\n- \"hero\" (Hero): 15 credits · Highly detailed, accurate 3D generation for close-up assets · front image only, no back_image.", "enum": [ "prop", "hero" ], "example": "prop" }, "back_image": { "type": "string", "description": "Optional URL or base64-encoded image of the SAME subject seen from behind (rotated 180 degrees from image). The model's back then follows it instead of being invented from the front view alone. It must show the same subject, at the same scale and in the same pose and style as image. Only a back view is supported: a side or three-quarter view here produces a distorted model. Prop model only: hero rejects it with HTTP 400. No extra cost.", "example": " OR data:image/png;base64,..." }, "target_num_faces": { "type": "integer", "default": 50000, "minimum": 1000, "maximum": 200000, "description": "Maximum triangle count for the mesh (1000-200000)", "example": 50000 }, "texture_size": { "type": "integer", "default": 2048, "description": "Texture resolution in pixels", "enum": [ 1024, 2048 ], "example": 2048 }, "texture_type": { "type": "string", "default": "pbr", "description": "Texture type", "enum": [ "pbr", "simple", "none" ], "example": "pbr" }, "rig": { "type": "boolean", "default": false, "description": "Also rig the model (skeleton and skin weights) in the same call, so it can be animated or rendered with createDirectionalSprites. It gets the general rig, which suits any shape; there is no rig type to pick here (rigModel offers the others). Adds the rigModel price, charged only when the model comes back rigged (the result's rigged).", "example": false }, "joint_naming": { "type": "string", "enum": [ "smpl", "mixamo", "humanik", "unreal", "godot", "rigify", "vroid" ], "default": "smpl", "description": "With rig, the bone naming convention (as rigModel's joint_naming). Purely a relabel - the skeleton is identical.", "example": "smpl" }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "Model3DResult": { "type": "object", "properties": { "model_url": { "type": "string", "description": "URL to the generated 3D model file", "example": "" }, "snapshots": { "type": "array", "items": { "type": "string" }, "description": "URLs to snapshot images from different angles (useful for previews and MCP agents)" }, "rigged": { "type": "boolean", "description": "True when the model carries a skeleton (asked for with rig)." } } }, "Rig3DModelPayload": { "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "description": "The 3D asset to rig, as a URL or base64-encoded GLB file (not an AI model name).", "example": " OR data:model/gltf-binary;base64,..." }, "rig_type": { "type": "string", "enum": [ "general", "humanoid", "game", "humanoid_template", "humanoid_template_hands" ], "default": "general", "description": "Which skeleton to build: general (default, any asset), humanoid (anime-style characters), game (classic game-character rigs), or the pinned humanoid templates with named joints - humanoid_template (22 joints) / humanoid_template_hands (52, five fingers per hand). Templates only suit two-armed, two-legged characters. Animation presets (animate3DModelPreset) retarget onto any rig type, though not onto every model.", "example": "general" }, "joint_naming": { "type": "string", "enum": [ "smpl", "mixamo", "humanik", "unreal", "godot", "rigify", "vroid" ], "default": "smpl", "description": "Bone naming convention for the identified joints: smpl (default), mixamo (Unity's humanoid auto-mapper), humanik (same names unprefixed - Maya/MotionBuilder/FBX), unreal (UE mannequin), godot (SkeletonProfileHumanoid), rigify (Blender) or vroid (VRM). Purely a relabel - the skeleton is identical.", "example": "smpl" }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "Rig3DModelResult": { "type": "object", "properties": { "model_url": { "type": "string", "description": "URL to the rigged GLB (skeleton + skin weights baked in).", "example": "" }, "rigged": { "type": "boolean" } } }, "Animate3DModelPayload": { "type": "object", "required": [ "model", "prompt" ], "properties": { "model": { "type": "string", "description": "The already-rigged 3D asset to animate, as a URL or base64-encoded GLB file (not an AI model name). Rig it first with rigModel if it has no skeleton.", "example": " OR data:model/gltf-binary;base64,..." }, "prompt": { "type": "string", "description": "Desired motion, e.g. \"walking\" or \"swinging its axe\"." }, "mode": { "type": "string", "enum": [ "rot_trans", "rot_only" ], "default": "rot_trans", "description": "Animation representation: rot_trans (per-bone rotation+translation, most faithful) or rot_only (rotation + root translation only, for retargeting).", "example": "rot_trans" }, "num_variants": { "type": "integer", "default": 4, "minimum": 1, "maximum": 8, "description": "Number of candidate animations to generate; each returned as a standalone animation-only GLB with an mp4 preview.", "example": 4 }, "loop": { "type": "boolean", "default": true, "description": "Return to the initial pose: each clip plays forward then mirrors back to the rest pose for a seamless loop. Best for one-way motions (crouch, punch, wave); reads oddly for cyclic gaits like walking.", "example": true }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites the prompt into a detailed motion caption with an LLM. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "AnimationCandidates": { "type": "object", "properties": { "animations": { "type": "array", "items": { "$ref": "#/components/schemas/AnimationClip" } } } }, "Animate3DPresetModelPayload": { "type": "object", "required": [ "model", "preset_id" ], "properties": { "model": { "type": "string", "description": "The already-rigged 3D asset, as a URL or base64-encoded GLB file (not an AI model name). Rig it first, with rigModel or with create3DModel's rig (any rig type).", "example": " OR data:model/gltf-binary;base64,..." }, "preset_id": { "type": "string", "description": "id of an animation preset from listAnimationPresets. Any preset id from that list works." }, "crop_loop": { "type": "boolean", "description": "Trim the animation to the span that loops seamlessly. Omit to follow the preset's own loop flag. Ignored when no clean loop exists." }, "in_place": { "type": "boolean", "description": "Remove the animation's net travel so the character moves on the spot (engine-driven locomotion). Omit to keep the preset's own travel." }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "GenerateSoundEffectPayload": { "type": "object", "description": "Payload for generating a sound effect from a text description", "required": [ "description" ], "properties": { "description": { "type": "string", "description": "Text description of the sound effect to generate (e.g., \"laser gun firing\", \"footsteps on gravel\")." }, "duration": { "type": "number", "format": "float", "minimum": 0, "maximum": 10, "default": 0, "description": "Duration in seconds. Use 0 for automatic duration based on the description.", "example": 0 }, "loop": { "type": "boolean", "default": false, "description": "Generate a sound effect that loops seamlessly.", "example": false }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "GenerateAmbiancePayload": { "type": "object", "description": "Payload for generating a seamless looping ambiance soundscape from a text description", "required": [ "description" ], "properties": { "description": { "type": "string", "description": "Text description of the ambiance to generate (e.g., \"windy forest at dusk\", \"busy tavern interior\")." }, "duration": { "type": "number", "format": "float", "minimum": 0, "maximum": 10, "default": 0, "description": "Duration in seconds. Use 0 for automatic duration based on the description.", "example": 0 }, "loop": { "type": "boolean", "default": true, "description": "Generate an ambiance that loops seamlessly.", "example": true }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "GenerateMusicPayload": { "type": "object", "description": "Payload for generating music from a text description", "required": [ "description" ], "properties": { "description": { "type": "string", "description": "Text description of the music to generate (e.g., \"epic orchestral battle theme\", \"calm piano melody\")." }, "lyrics": { "type": "string", "description": "Optional lyrics to include in the generated music." }, "duration": { "type": "integer", "default": 0, "description": "Duration in seconds. Use 0 for automatic duration based on the description.", "enum": [ 0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 110, 120, 130, 140, 150, 160, 170, 180 ], "example": 0 }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "GenerateAudioTransformPayload": { "type": "object", "description": "Payload for remixing an audio sample (sound effect, ambiance or music) into a variation guided by a text prompt", "required": [ "sample", "prompt" ], "properties": { "sample": { "type": "string", "description": "URL or base64-encoded source audio sample to remix (15MB max).", "example": " OR data:audio/mp3;base64,..." }, "prompt": { "type": "string", "description": "Text description guiding the remix (e.g., \"make it sound like an 80s synthwave track\", \"turn this into a metal version\")." }, "duration": { "type": "integer", "default": 0, "description": "Duration in seconds. Use 0 for automatic duration matching the source sample.", "enum": [ 0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 110, 120, 130, 140, 150, 160, 170, 180 ], "example": 0 }, "modification_strength": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "default": 0.6, "description": "Controls how strongly the source sample is modified. 0 keeps it close to the original, 1 transforms it fully.", "example": 0.6 }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "GenerateVoicePayload": { "type": "object", "description": "Payload for generating a voice sample from a character description and/or a character image", "required": [ "text" ], "properties": { "voice_description": { "type": "string", "description": "Text description of the voice character (e.g., \"deep-voiced warrior\", \"cheerful young girl\"). Required unless image is given; with an image, a few words of hints." }, "image": { "type": "string", "description": "URL or base64-encoded image of the speaking character (concept art, at most 15MB). The voice is designed from it, and voice_description becomes optional.", "example": " OR data:image/png;base64,..." }, "text": { "type": "string", "description": "Text for the voice to speak (max 100 characters).", "maxLength": 100, "minLength": 1 }, "type": { "type": "string", "default": "human", "description": "Type of voice to generate.", "enum": [ "human", "non-human" ], "example": "human" }, "augment_prompt": { "type": "boolean", "default": true, "description": "Rewrites your prompt behind the scenes into the form the model works best with. Leave it on (the default). Turning it off does not give you more control - it usually gives worse results. Do not disable it unless you really know what you are doing and have tested your prompts extensively.", "example": true }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "GenerateSpeechPayload": { "type": "object", "description": "Payload for text-to-speech generation using voice cloning", "required": [ "text", "sample" ], "properties": { "text": { "type": "string", "description": "Text to convert to speech (max 250 characters).", "maxLength": 250, "minLength": 1 }, "sample": { "type": "string", "description": "URL or base64-encoded audio sample for voice cloning.", "example": " OR data:audio/mp3;base64,..." }, "delivery": { "type": "string", "description": "How the line is said, e.g. \"angry, shouting\" or \"whispering, out of breath\" (max 50 characters).", "maxLength": 50 }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "GenerateSpeechPresetPayload": { "type": "object", "description": "Payload for text-to-speech generation using a voice preset", "required": [ "text", "voice_preset_id" ], "properties": { "text": { "type": "string", "description": "Text to convert to speech (max 250 characters).", "maxLength": 250 }, "voice_preset_id": { "type": "string", "description": "Voice preset identifier. Two families of voices: the ones named by a first name (e.g. \"Rachel\", \"Roger\") take a delivery note and no emotion; the descriptive ones (e.g. \"Serious woman\", \"Deep voice man\") take an emotion and no delivery note.", "enum": [ "Serious woman", "Wise woman", "Calm woman", "Fast-paced woman", "Calm young girl", "Expressive teen girl", "Calm teen girl", "Sweet girl", "Patient man", "Determined man", "Young elegant man", "Teen boy", "Friendly man", "Deep voice man", "Rachel", "Aria", "Roger", "Sarah", "Laura", "Charlie", "George", "Callum", "River", "Liam", "Charlotte", "Alice", "Matilda", "Will", "Jessica", "Eric", "Chris", "Brian", "Daniel", "Lily", "Bill" ], "example": "Serious woman" }, "emotion": { "type": "string", "description": "Emotion to apply to the speech. Only for the descriptive voices (e.g. \"Serious woman\"); a first-name voice returns HTTP 400 for any emotion other than Default - use delivery instead.", "enum": [ "Default", "Happy", "Sad", "Angry", "Fearful", "Disgusted", "Surprised", "Neutral" ], "example": "Default" }, "delivery": { "type": "string", "description": "How the line is said, e.g. \"angry, shouting\" or \"whispering, out of breath\" (max 50 characters). Only for the first-name voices (e.g. \"Rachel\"); a descriptive voice returns HTTP 400 - use emotion instead.", "maxLength": 50 }, "language": { "type": "string", "description": "Language of the speech. Each voice family supports its own list of languages; \"auto\" detects it from the text.", "enum": [ "auto", "English", "Afrikaans", "Arabic", "Bulgarian", "Catalan", "Chinese", "Chinese,Yue", "Croatian", "Czech", "Danish", "Filipino", "Finnish", "French", "German", "Greek", "Hebrew", "Hindi", "Hungarian", "Indonesian", "Italian", "Japanese", "Korean", "Malay", "Norwegian", "Nynorsk", "Persian", "Polish", "Portuguese", "Romanian", "Russian", "Slovak", "Slovenian", "Spanish", "Swedish", "Tamil", "Thai", "Turkish", "Ukrainian", "Vietnamese", "Armenian", "Assamese", "Asturian", "Azerbaijani", "Belarusian", "Bengali", "Bosnian", "Burmese", "Cebuano", "Dutch", "Estonian", "Galician", "Georgian", "Gujarati", "Hausa", "Icelandic", "Irish", "Javanese", "Kannada", "Kazakh", "Kyrgyz", "Latvian", "Lingala", "Lithuanian", "Luxembourgish", "Macedonian", "Malayalam", "Maltese", "Maori", "Marathi", "Mongolian", "Nepali", "Occitan", "Odia", "Pashto", "Punjabi", "Serbian", "Sindhi", "Somali", "Swahili", "Tajik", "Telugu", "Urdu", "Uzbek", "Welsh", "Yoruba" ], "example": "auto" }, "request_id": { "type": "string", "description": "Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations." }, "async": { "type": "boolean", "default": true, "description": "Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.", "example": true } } }, "GenerationList": { "type": "object", "properties": { "items": { "type": "array", "description": "This page of results, newest first.", "items": { "$ref": "#/components/schemas/GenerationListItem" } }, "page": { "type": "integer", "description": "The 1-based page number these items came from." }, "page_size": { "type": "integer", "description": "The page size actually applied (your page_size, clamped to 1-100)." }, "has_more": { "type": "boolean", "description": "Whether at least one more page exists after this one. Page until this is false rather than until you get a short page." } } }, "ThreeDModelResult": { "type": "object", "properties": { "model_url": { "type": "string", "example": "" }, "snapshots": { "type": "array", "items": { "type": "string" } }, "request_id": { "type": "string" }, "created_at": { "type": "integer" } } }, "CreateUploadPayload": { "type": "object", "description": "Payload for starting a file upload.", "required": [ "mime_type", "size" ], "properties": { "mime_type": { "type": "string", "description": "MIME type of the file. Fixed for the upload; the stored file is served with it.", "enum": [ "image/png", "image/jpeg", "image/webp", "image/gif", "audio/mpeg", "audio/wav", "audio/x-wav", "audio/ogg", "audio/flac", "audio/mp4", "audio/aac", "audio/webm", "video/mp4", "video/webm", "video/quicktime", "model/gltf-binary" ], "example": "image/png" }, "size": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 15728640, "description": "Exact size of the file in bytes (at most 15MB). The PUT to upload_url must send exactly this many bytes." } } }, "UploadSession": { "type": "object", "required": [ "upload_url", "file_url", "mime_type", "size" ], "properties": { "upload_url": { "type": "string", "description": "Single-use URL to PUT the file's bytes to, with no Authorization header.", "example": "" }, "file_url": { "type": "string", "description": "Public URL of the file once the PUT succeeds. Pass it to any field that accepts a URL. Deleted 7 days after upload.", "example": "" }, "mime_type": { "type": "string", "description": "The MIME type the file is stored and served with." }, "size": { "type": "integer", "format": "int64", "description": "The exact number of bytes the PUT must send." } } }, "AccountInfo": { "type": "object", "properties": { "credits": { "type": "object", "properties": { "available": { "type": "number", "format": "float", "description": "Credits generations can spend right now." }, "plan_credits": { "type": "number", "format": "float", "description": "The plan's credits for the current cycle." }, "used": { "type": "number", "format": "float", "description": "Plan credits used this cycle." }, "extra": { "type": "number", "format": "float", "description": "Credits from top-ups and grants, on top of the plan." }, "resets_at": { "type": "integer", "format": "int64", "description": "When the plan credits refill (unix seconds)." }, "team_pool": { "type": "boolean", "description": "The balance is a team's shared pool." }, "paused": { "type": "boolean" }, "grace_until": { "type": "integer", "format": "int64", "description": "Set when the subscription ended; remaining credits stay spendable until then (unix seconds)." } } }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "api_access": { "type": "boolean" } } }, "auto_topup": { "type": "object", "description": "Null for team members; the team owner manages auto top-up.", "properties": { "enabled": { "type": "boolean" }, "threshold": { "type": "number", "format": "float", "description": "An automatic top-up is bought when available credits drop below this." }, "credits": { "type": "integer", "description": "Credits bought on each automatic top-up." } } }, "billing_url": { "type": "string", "description": "Web page to buy credits, change plan or change auto top-up.", "example": "" } } }, "OkResponse": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "ApiFeedbackPayload": { "type": "object", "required": [ "category", "message" ], "properties": { "category": { "type": "string", "enum": [ "limitation", "bug", "feature_request", "praise", "other" ], "description": "bug - the API errored, a job failed or got stuck, or a response did not match the documentation; limitation - the API does not support a parameter, operation or format you needed; feature_request - a new API capability you would like; praise - something that worked well; other - any other API issue. Generated content that looks wrong or does not match the prompt is a model limitation, not a bug: do not report it. A limitation the docs already describe (check with searchDocs) is known: do not report it.", "example": "limitation" }, "message": { "type": "string", "minLength": 1, "maxLength": 4000, "description": "What you were trying to do, what happened, and what would have helped." }, "operation": { "type": "string", "maxLength": 100, "description": "The operation the feedback is about, e.g. animateSprite." }, "job_id": { "type": "string", "maxLength": 64, "description": "The id of the job the feedback is about. Same as a one-item job_ids." }, "job_ids": { "type": "array", "maxItems": 10, "items": { "type": "string", "maxLength": 64 }, "description": "The ids of the jobs the feedback is about (returned by each generation call; also in getApiJob and listApiJobs). Send them whenever a job is involved: every job that shows the problem, plus the one that worked if you are comparing." }, "agent": { "type": "string", "maxLength": 100, "description": "The agent or app sending it, e.g. Claude Code." } } }, "ApiFeedbackReceipt": { "type": "object", "properties": { "ok": { "type": "boolean" }, "id": { "type": "string" } } }, "PublicJobError": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32" }, "message": { "type": "string" } } }, "ModelLineup": { "type": "object", "description": "Which models to use. Present on the table of contents only (no `doc` parameter).", "properties": { "current": { "$ref": "#/components/schemas/CurrentModelsByAction" }, "legacy": { "type": "array", "description": "Legacy models: still accepted for existing integrations but scheduled for removal. Do not use them for new work.", "items": { "$ref": "#/components/schemas/LegacyModel" } } } }, "DocumentationEntry": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable document id, e.g. sprite-generator - pass it back as the `doc` parameter" }, "label": { "type": "string", "description": "Human-readable document name, e.g. Sprite Generator" }, "sections": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentationSection" } } } }, "DocumentationSearchResult": { "type": "object", "properties": { "doc": { "type": "string", "description": "Document id, e.g. sprite-generator - pass it to getDocs as `doc`" }, "label": { "type": "string", "description": "Human-readable document name, e.g. Sprite Generator" }, "section": { "type": "string", "description": "Section title - pass it to getDocs in `sections`" }, "relevance": { "type": "number", "format": "float", "description": "Match score 0-1; only results at or above 0.6 are returned" }, "content": { "type": "string", "description": "Full markdown body of the section, as getDocs would return it. Request and response schemas for each tool are in the tool definitions, not in these sections." } } }, "AnimationPresetPublic": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "duration": { "type": "number", "format": "float" }, "preview_url": { "type": "string", "example": "" } } }, "AnimationPerspective": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "DirectionalSpriteStyle": { "type": "object", "properties": { "id": { "type": "string", "description": "Pass as style_id." }, "label": { "type": "string" }, "description": { "type": "string" }, "family": { "type": "string" }, "pixel": { "type": "boolean", "description": "Whether the style is pixel art." }, "thumbnail_url": { "type": "string", "description": "The style at its defaults.", "example": "" }, "version": { "type": "integer", "description": "The style's current version." }, "settings": { "type": "array", "description": "The style's settings: each has a name (its key in style_params), label, description, kind (choice, bool or color), options ({label, value}) and default.", "items": { "type": "object" } }, "advanced_settings": { "type": "array", "description": "Finer settings, described the same way.", "items": { "type": "object" } } } }, "DirectionalPreview": { "type": "object", "properties": { "direction": { "type": "string", "description": "The direction this preview is seen from." }, "frame_urls": { "type": "array", "description": "The preview's frames as images, in order (one for a still model). Kept for 7 days.", "items": { "type": "string", "example": "" } }, "width": { "type": "integer" }, "height": { "type": "integer" }, "num_frames": { "type": "integer" }, "fps": { "type": "number", "format": "float" }, "render_3d": { "$ref": "#/components/schemas/DirectionalSpriteRender" } } }, "DirectionalSpriteSheet": { "type": "object", "properties": { "direction": { "type": "string", "description": "The direction this sheet is seen from." }, "spritesheet_url": { "type": "string", "example": "" }, "video_url": { "type": "string", "example": "" }, "gif_url": { "type": "string", "example": "" }, "individual_frame_urls": { "type": "array", "items": { "type": "string", "example": "" } }, "num_frames": { "type": "integer", "description": "Number of frames in the spritesheet." }, "num_cols": { "type": "integer", "description": "Columns in the frame grid. Frames run left-to-right, top-to-bottom." }, "num_rows": { "type": "integer", "description": "Rows in the frame grid. The last row may be only partly filled." }, "fps": { "type": "number", "format": "float", "description": "The frame rate the sheet plays at." }, "render_3d": { "$ref": "#/components/schemas/DirectionalSpriteRender" } } }, "DirectionalStill": { "type": "object", "properties": { "direction": { "type": "string", "description": "The direction this image is seen from." }, "url": { "type": "string", "example": "" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "render_3d": { "$ref": "#/components/schemas/DirectionalSpriteRender" } } }, "AnimationClip": { "type": "object", "properties": { "clip_name": { "type": "string" }, "prompt": { "type": "string" }, "preset_id": { "type": "string", "description": "Set when the clip came from the preset library (retargeting) rather than a text prompt." }, "mode": { "type": "string", "enum": [ "rot_trans", "rot_only" ], "example": "rot_trans" }, "seed": { "type": "integer" }, "glb_url": { "type": "string", "example": "" }, "preview_url": { "type": "string", "example": "" }, "motion": { "type": "number", "format": "float" }, "fit_rmse": { "type": "number", "format": "float" } } }, "GenerationListItem": { "type": "object", "properties": { "id": { "type": "string", "description": "Generation-history id of this item, identifying it across these listings. API-originated results expire after 7 days - download anything you want to retain. (Assets can be kept permanently from the Ludo web app.)" }, "type": { "type": "string", "description": "The media type of this item, echoing the requested `type`.", "enum": [ "image", "spritesheet", "video", "audio", "3d" ], "example": "image" }, "request_id": { "type": "string" }, "created_at": { "type": "integer", "description": "When the item was generated (unix seconds)." }, "url": { "type": "string", "description": "image / video / audio: URL to the generated file.", "example": "" }, "duration": { "type": "number", "format": "float", "description": "video / audio / spritesheet: duration in seconds." }, "has_audio": { "type": "boolean", "description": "video only." }, "audio_type": { "type": "string", "description": "audio only: the kind of audio (sfx, music, speech). Named `audio_type` here, not `type`, because `type` reports the media type on every item." }, "spritesheet_url": { "type": "string", "description": "spritesheet only.", "example": "" }, "video_url": { "type": "string", "description": "spritesheet only: preview video.", "example": "" }, "audio_url": { "type": "string", "description": "spritesheet only: URL of the sheet's sound effect (MP3 or WAV; the extension says which), when it has one.", "example": "" }, "num_frames": { "type": "integer", "description": "spritesheet only." }, "num_cols": { "type": "integer", "description": "spritesheet only: columns in the frame grid. Frames run left-to-right, top-to-bottom." }, "num_rows": { "type": "integer", "description": "spritesheet only: rows in the frame grid. The last row may be only partly filled." }, "model_url": { "type": "string", "description": "3d only: URL to the generated model file.", "example": "" }, "snapshots": { "type": "array", "items": { "type": "string" }, "description": "3d only: preview snapshot URLs." } } }, "CurrentModelsByAction": { "type": "object", "description": "Per credit action, the current model codenames in preference order. Pick from these for new work.", "properties": { "ANIMATE_SPRITE": { "type": "array", "items": { "type": "string" } }, "TRANSFER_SPRITE_MOTION": { "type": "array", "items": { "type": "string" } }, "EDIT_SPRITESHEET": { "type": "array", "items": { "type": "string" } }, "NEW_VIEW_SPRITESHEET": { "type": "array", "items": { "type": "string" } }, "GENERATE_VIDEO": { "type": "array", "items": { "type": "string" } }, "REFERENCES_TO_VIDEO": { "type": "array", "items": { "type": "string" } }, "VIDEO_EDIT": { "type": "array", "items": { "type": "string" } } } }, "LegacyModel": { "type": "object", "properties": { "codename": { "type": "string" }, "name": { "type": "string" }, "legacy_since": { "type": "string", "description": "Date (YYYY-MM-DD) the model became legacy." }, "features": { "type": "array", "description": "Credit actions the model still accepts; empty once fully retired.", "items": { "type": "string" } } } }, "DocumentationSection": { "type": "object", "properties": { "title": { "type": "string" }, "content": { "type": "string" } } }, "DirectionalSpriteRender": { "type": "object", "properties": { "style_id": { "type": "string" }, "style_version": { "type": "integer" }, "style_params": { "type": "object", "description": "The style's settings as rendered, by name." }, "perspective": { "type": "string" }, "direction": { "type": "string" }, "animation_name": { "type": "string" }, "fps": { "type": "number", "format": "float" }, "keep_horizontal_travel": { "type": "boolean" }, "keep_vertical_travel": { "type": "boolean" } } } } } }