Multi-Color Print API

Required unless you send model_url. The ID of the task whose model you want to print, for example an Image to 3D, Multi-Image to 3D, Text to 3D, Remesh, or Retexture task. The task must be one you created with the API, and have the status SUCCEEDED.

Multi-Color Print reads the task's GLB file, which can have at most 8,000,000 faces. A model with more faces returns 400. In that case, run a Remesh task on it first, and send the Remesh task's ID instead.

Required unless you send input_task_id. The model to print, as a public URL or a data URI. If you send both, Meshy uses input_task_id.

An http or https URL must point to a .glb or .fbx file of at most 400 MB. A data URI must hold a base64 GLB file of at most 100 MB. Use data:model/gltf-binary;base64,. Send an .fbx file as an http or https URL.

A file over 100 MB must also follow these rules:

• It can have at most 8,000,000 faces. Meshy counts faces as triangles, so a quad counts as 2, and a mesh drawn more than once counts once per copy.
• An FBX file must be binary FBX 7.1 or newer.
• A GLB file must not use Draco compression.

The maximum number of colors in the output palette, from 1 to 16. To use the default, leave it out rather than sending 0.

The color style of the 3MF file.

Available values:

• realistic: samples colors directly from the model's texture for fine, photo-realistic detail, and makes a larger file.
• cartoon: flattens colors into clean, uniform regions for a stylized look, and makes a smaller file.

The model must have color. realistic needs a single base color texture, with UVs on every mesh part, and cartoon also accepts vertex colors. Meshy rejects an untextured (white) model. See model_missing_texture.

The subdivision depth Meshy uses to sample texture colors onto the mesh, from 3 to 6. 0 is the same as leaving it out. Higher values capture finer color detail, and make a larger file. Only the realistic style uses it, and cartoon ignores it.

The printer brand whose slicer preset Meshy writes into the 3MF file. The file then opens in that brand's slicer with a matching printer, filament, and process profile. The preset uses the brand's default printer, with a 0.4 mm nozzle.

Available values:

• bambu
• anycubic
• creality
• elegoo
• flashforge
• prusa
• qidi
• snapmaker
• ankermake

Any other value returns 400.

The request can't run. The error message says which problem it found. For example:

• Missing parameter: Neither model_url nor input_task_id was sent.
• Invalid model format: The model_url file isn't a .glb or .fbx file.
• Unreachable URL: Meshy can't download the model_url file.
• Model file too large: The model_url file is over 400 MB from an http or https URL, or over 100 MB as a data URI.
• Too many faces: The model_url file is over 100 MB and has more than 8,000,000 faces. Reduce the face count, then send the file again.
• ASCII FBX over 100 MB: The model_url file is an ASCII FBX over 100 MB. Send it as binary FBX or GLB.
• Unreadable model file: The model_url file is over 100 MB, and Meshy can't read its header. For example, it's a Draco-compressed GLB, or a binary FBX older than 7.1.
• Model header too complex: The model_url file is over 100 MB, and its header has too many meshes, nodes, or records to check. Reduce the number of objects in the file, then send it again.
• Invalid input task: input_task_id isn't a successful task.
• Too many faces in the input task: The input_task_id model has more than 8,000,000 faces. Run a Remesh task on it, then send the Remesh task's ID instead.
• Invalid max_colors: max_colors is negative or over 16.
• Invalid style: style isn't realistic or cartoon.
• Invalid max_depth: max_depth is outside 3 to 6, and isn't 0.
• Invalid printer_brand: printer_brand isn't one of its available values.
• No color source: The model lacks the color that style needs. realistic needs a single base color texture, with UVs, on every mesh part. cartoon accepts a base color texture or vertex colors. Texture the model first, or use cartoon for a model with vertex colors. Meshy checks an .fbx upload only after the task normalizes it, so the task fails with model_missing_texture instead.

Fix the request, then send it again. See Errors.

The API key is missing or invalid. Check the Authorization header.

For example:

• Insufficient credits: The account doesn't have enough credits for this task, or the account reached a credit limit. Check your credit balance, then retry.
• Free plan: Creating a task requires a paid plan. Upgrade your plan in your subscription settings, then retry.

input_task_id is a bas-relief model, which this endpoint can't print. The message is This model type does not support this operation. Send a different model.

input_task_id doesn't match any of your tasks. Check the task ID, then send the request again.

You exceeded your rate limit. Wait, then retry. See Rate limits.

The task ID from the create response.

The ID of the task to delete.

The page number to return. Page numbers start at 1.

The number of tasks per page, up to 100.

The sort order.

Available values:

• +created_at: oldest first
• -created_at: newest first

The task ID from the create response.

The task ID. Treat it as an opaque string, and don't rely on its format.

The task type, always print-multi-color.

Download URLs for the printed model, one per file format. A format the task didn't generate has no key, rather than an empty string.

How much of the task is done, as a percentage. It's 0 until the task starts and 100 when it succeeds.

The task status, one of PENDING, IN_PROGRESS, SUCCEEDED, or FAILED.

The number of tasks ahead of this one in the queue. The value is meaningful only while the task is PENDING.

Time the task was created, in Unix milliseconds.

Time the task started, in Unix milliseconds. It's 0 until the task starts.

Time the task finished, in Unix milliseconds. It's 0 until the task finishes.

The error details when the task fails. See Errors.

The number of credits the task used. Present when the status is PENDING, IN_PROGRESS, or SUCCEEDED. It's 0 for a FAILED task, because Meshy refunds the credits when a task fails.