Skip to main content
Meshy logo
  • Category: media generation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 27
  • Triggers: 0
  • Slug: MESHY
  • Version: 20261101_00

Tools

Slug: MESHY_CANCEL_CREATIVE_LAB_TASKRequest deletion of a Creative Lab task by type and ID. Deleting a pending task cancels it and refunds credits; in-progress tasks cannot be canceled, while terminal tasks can be deleted.

Input Parameters

string
required
ID of a PENDING or IN_PROGRESS Creative Lab task to cancel.
string ("creative_lab_keychain_prototype" | "creative_lab_keychain_build" | "creative_lab_fridge_magnet_prototype" | "creative_lab_fridge_magnet_build" | "creative_lab_figure_prototype" | "creative_lab_figure_build" | "creative_lab_vinyl_figure_prototype" | "creative_lab_vinyl_figure_build" | "creative_lab_brick_figure_prototype" | "creative_lab_brick_figure_build" | "creative_lab_lamp_prototype" | "creative_lab_lamp_build" | "creative_lab_keycap_prototype" | "creative_lab_keycap_build" | "creative_lab_fidget_pixel_prototype" | "creative_lab_fidget_pixel_build" | "creative_lab_fidget_collapsible")
required
Creative Lab task family that owns the ID; selects a fixed documented cancellation endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_ANIMATION_TASKStart a 3-credit task that applies either a selected library animation or a succeeded Text to Motion clip to a completed rigging task and return the animation task ID.

Input Parameters

string
Optional task name.
integer
Identifier of the preset animation action to apply, returned by MESHY_LIST_ANIMATION_LIBRARY. Provide exactly one of action_id or motion_task_id.
string
required
Completed Meshy rigging task ID whose model will be animated.
object
Optional post-processing operation for changing frame rate, converting FBX to USDZ, or extracting the armature.
string
ID of a successfully completed Text to Motion task to apply instead of a preset action. The generated clip is retargeted onto the rigged character and snapshotted when this task is created. Source assets are retained for 3 days, so apply the clip before it expires. Requires a biped rig. Provide exactly one of action_id or motion_task_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_AUTO_SPLIT_TASKSplit a succeeded untextured Meshy 6 or Meshy 7 model into separately printable parts and return the task ID. An accepted task costs 10 credits; failed tasks are refunded, as is a task deleted while still pending.

Input Parameters

string ("auto" | "by_parts" | "by_color")
Split automatically, by named structural parts, or by named color regions. by_color requires an Image to 3D or Multi-Image to 3D source.
string ("assembled" | "on_plate")
Keep parts assembled or lay them out separately on a build plate.
string
One to ten part names in any language, not a general description. Required for by_parts and by_color and ignored for auto. Meshy rejects prompts naming fewer than two parts; an unreadable prompt falls back to auto and the task reports prompt_ignored.
boolean
Add mortise-and-tenon connectors at each cut.
string
required
Succeeded, untextured Meshy 6 or Meshy 7 Image to 3D, Multi-Image to 3D, Text to 3D preview, Remesh, Convert, or Resize task whose model will be split.
number
Connector size relative to the cut surface. Only valid when connectors is true.
string ("cube" | "cylinder")
Connector shape. Only valid when connectors is true.
array
Output formats. GLB is always produced; STL is not supported.
number
Connector extension relative to the cut surface. Only valid when connectors is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_COLLAPSIBLE_FIDGET_TASKStart an entitled 6-credit task that generates a collapsible fidget directly from an image and return the task ID.

Input Parameters

string
Optional task name, up to 100 characters.
string
required
Public HTTP(S) URL or base64 data URI for a JPG, JPEG, PNG, or WebP source image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_CONVERT_TASKStart a 1-credit task that converts a model into one or more requested formats; returns the task ID.

Input Parameters

string
Model HTTP(S) URL or data URI to convert. Required when input_task_id is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
string
Prior Meshy task ID containing the model to convert. Required when model_url is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
array
required
One or more output formats: glb, obj, fbx, stl, usdz, blend, or 3mf.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_CREATIVE_LAB_BUILDStart a 3D build from a succeeded matching Creative Lab prototype. Lamp builds cost 6 credits, keycap builds cost 50, and all other builds cost 30. The call returns a build task ID.

Input Parameters

string
Optional task name.
string ("keychain" | "fridge_magnet" | "figure" | "vinyl_figure" | "brick_figure" | "lamp" | "keycap" | "fidget_pixel")
required
Creative Lab product to build. It must match the succeeded prototype task.
string
Required when product=‘keycap’ and must include a non-empty candidate_id. Optional when product is ‘keychain’, ‘fridge_magnet’, ‘lamp’, or ‘fidget_pixel’. Omit for figure, vinyl_figure, or brick_figure; build_options is rejected for those products.
string
required
Succeeded prototype task ID created for the selected product with the same Meshy API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_CREATIVE_LAB_PROTOTYPEStart an entitled image-to-prototype task for a fixed Creative Lab product. Lamp prototypes cost 30 credits, keycap prototypes cost 12, and all other prototypes cost 6. The task ID can be passed to the matching build operation.

Input Parameters

string
Optional task name of at most 100 characters.
string ("keychain" | "fridge_magnet" | "figure" | "vinyl_figure" | "brick_figure" | "lamp" | "keycap" | "fidget_pixel")
required
Creative Lab product prototype to generate; selects one fixed documented endpoint.
string
required
Public image URL or base64 data URI containing a JPG, JPEG, PNG, or WebP image.
string
Required when product=‘fidget_pixel’: set the nested product discriminator to ‘fidget_pixel’ and provide a non-empty type. Optional when product is ‘keychain’ or ‘lamp’, with the nested product discriminator matching the top-level product. Omit for fridge_magnet, figure, vinyl_figure, brick_figure, or keycap; product_options is rejected for those products.
boolean
Whether Meshy should return a transparent prototype image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_IMAGE_TO_3D_TASKStart a 3D generation task from one to four views of one object or a prior task’s input images. One image uses single-image generation and two to four use multi-image generation. Meshy-6/7 cost 20 credits without texture, 30 with texture, or 35 with 8K texture; single-image Meshy T2 costs 5, 15, or 20 respectively; other models cost 5 without or 15 with texture. Ultra on Meshy-7 adds 5 credits. Returns task_id and the exact task_type discriminator for GET_TASK, LIST_TASKS, or DELETE_TASK.

Input Parameters

string
Optional task name, up to 100 characters.
string ("meshy-5" | "meshy-6" | "meshy-7" | "latest" | "meshy-t2")
Meshy model to use. When omitted, Meshy selects the endpoint and model-type default. meshy-t2 is single-image only and requires model_type=‘smart-topology’; meshy-7 may require account entitlement. Pricing before add-ons: meshy-6 and meshy-7 cost 20 credits without texture or 30 with texture; meshy-t2 costs 5 without texture or 15 with texture; other models cost 5 without texture or 15 with texture.
string ("quad" | "triangle")
Output mesh topology. Quad topology is not supported by meshy-t2.
boolean
Whether to estimate the model’s real-world size automatically.
string ("bottom" | "center")
Place the model origin at its bottom or center.
string ("a-pose" | "t-pose")
Force an A-pose or T-pose for a character model.
boolean
Whether to produce physically based rendering texture maps.
array
One to four views of the same object. One image uses Meshy’s single-image pipeline; two to four images use its multi-image pipeline. One of image_urls or input_task_id is required. If both are provided, input_task_id takes priority and image_urls is ignored.
string ("standard" | "lowpoly" | "smart-topology")
Single-image-only generation pipeline: standard, lowpoly, or smart-topology.
boolean
Whether to run content moderation.
boolean
Enable the high-detail pass. Ultra adds 5 credits to the applicable meshy-7 price and requires account entitlement; it requires meshy-7 for single-image or meshy-7/latest for multi-image generation.
object
Single-image-only experimental generation options.
string
Prior task whose input image or images should be reused. One of input_task_id or image_urls is required; if both are provided, this task takes priority. Also provide input_image_count.
boolean
Whether to remesh after the draft stage. The default depends on the model.
boolean
Whether to run the texture stage. Texturing adds 10 credits to the base 5- or 20-credit generation price.
array
Additional output formats: glb, obj, fbx, stl, usdz, or 3mf.
string
Optional texture description, up to 800 characters. If texture_image_url is also provided, texture_prompt takes priority and texture_image_url is ignored. For multi-image generation it is mutually exclusive with texture_image_urls.
boolean
Whether to produce a transparent-background preview.
integer ("1" | "2" | "3" | "4")
Decimation algorithm selector from 1 through 4.
boolean
Whether to remove baked lighting. Not supported with smart-topology.
integer
Target polygon count from 100 to 300000. When omitted, Meshy chooses the single-image default or 30000 for multi-image generation.
boolean
Whether to enhance the input image(s). Not supported with smart-topology.
integer
Number of input images in input_task_id. Required only with input_task_id; 1 selects the single-image pipeline and 2-4 select the multi-image pipeline.
string
Optional single texture reference as an HTTP(S) URL or data URI. For single- or multi-image generation, texture_prompt takes priority if both are provided. For multi-image generation it is mutually exclusive with texture_image_urls.
array
Multi-image-only texture reference views, with the primary view first. Requires should_texture and meshy-7/latest; mutually exclusive with texture_prompt and texture_image_url.
string ("2k" | "4k" | "8k")
Texture resolution tier: 2k, 4k, or 8k. An 8K texture adds 5 credits for meshy-6, meshy-7, and single-image meshy-t2, making their textured prices 35, 35, and 20 credits respectively. Other textured models remain 15 credits; meshy-5 does not support 4K or 8K.
boolean
Whether to render front, right, back, and left thumbnails.
boolean
Whether to include the model produced before remeshing in task outputs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_IMAGE_TO_IMAGE_TASKStart a credit-consuming task that edits or restyles one to five reference images from a text instruction. The task costs 3 to 12 credits depending on the model and returns a task ID for status checks.

Input Parameters

string
required
Text instruction describing the transformation or edit to apply.
string ("nano-banana" | "nano-banana-pro" | "nano-banana-2" | "gpt-image-2")
required
Meshy image-edit model to use.
string ("1:1" | "16:9" | "9:16" | "4:3" | "3:4" | "3:2" | "2:3")
Output aspect ratio. gpt-image-2 supports 1:1, 16:9, 9:16, 3:2, and 2:3; nano-banana models support 1:1, 16:9, 9:16, 4:3, and 3:4. Do not set this with generate_multi_view.
boolean
Whether to return a transparent RGBA PNG with the background removed. Available only for single-image output.
boolean
Whether to generate a split image showing the subject from multiple angles. Cannot be combined with aspect_ratio or background removal.
array
required
One to five reference images to edit from, provided as public HTTP(S) URLs or JPEG/PNG data URIs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_MULTI_COLOR_PRINT_TASKStart a 10-credit task that converts a GLB or FBX model from a prior Meshy task or direct URL into a limited-color 3MF for 3D printing, and return the task ID. When both sources are provided, input_task_id takes precedence.

Input Parameters

string ("realistic" | "cartoon")
Color-placement algorithm to use.
integer
Quadtree depth from 3 to 6; used by the realistic style.
string
HTTP(S) URL or data URI for a GLB or FBX model. Required when input_task_id is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
integer
Target number of colors, from 1 to 16.
string
Prior Meshy task containing the GLB model. Required when model_url is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_PRINT_ANALYSIS_TASKStart a free task that analyzes a GLB, GLTF, OBJ, FBX, or STL model from a prior Meshy task or direct URL for printability defects and return the task ID. When both sources are provided, input_task_id takes precedence.

Input Parameters

string
GLB, GLTF, OBJ, FBX, or STL HTTP(S) URL or data URI. Required when input_task_id is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
string
Prior Meshy task ID containing the model to analyze. Required when model_url is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_PRINT_REPAIR_TASKStart a 10-credit task that repairs a GLB, GLTF, OBJ, FBX, or STL model from a prior Meshy task or direct URL for 3D printing and return the task ID. When both sources are provided, input_task_id takes precedence. The repaired asset retains the input format.

Input Parameters

string
GLB, GLTF, OBJ, FBX, or STL model HTTP(S) URL or data URI. Required when input_task_id is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
string
Prior Meshy task ID containing the GLB, STL, or OBJ model to repair. Required when model_url is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
boolean
Generate a transparent-background preview thumbnail.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_REMESH_TASKStart a 5-credit task that remeshes a model to the requested topology and polygon count, optionally resizes it, and exports the remeshed result in the requested formats. Use CREATE_CONVERT_TASK for format conversion without remeshing. Returns the remesh task ID.

Input Parameters

string ("quad" | "triangle")
Output mesh topology.
boolean
Automatically estimate real-world size; mutually exclusive with explicit sizing fields.
string
Model HTTP(S) URL or data URI to remesh. Required when input_task_id is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
string ("bottom" | "center")
Place the model origin at its bottom or center.
string
Prior Meshy task ID containing the model to remesh. Required when model_url is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
number
Target height in meters; mutually exclusive with resize_longest_side and auto_size.
array
Formats for the remeshed output. Defaults to glb. Use CREATE_CONVERT_TASK when only format conversion is needed.
boolean
Generate a transparent-background preview thumbnail.
integer ("1" | "2" | "3" | "4")
Decimation algorithm selector from 1 through 4.
integer
Target polygon count from 100 to 300000.
number
Target longest side in meters; mutually exclusive with resize_height and auto_size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_RESIZE_TASKStart a 1-credit task that scales a model by height, longest side, or automatic sizing and return the task ID.

Input Parameters

boolean
Automatically estimate real-world size; choose exactly one sizing method.
string
Model HTTP(S) URL or data URI to resize. Required when input_task_id is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
string ("bottom" | "center")
Place the resized model origin at its bottom or center.
string
Prior Meshy task ID containing the model to resize. Required when model_url is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
number
Target height in meters; choose exactly one sizing method.
number
Target longest side in meters; choose exactly one sizing method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_RETEXTURE_TASKStart a credit-consuming task that applies one text, image, or multiview style source to an existing 3D model. The task costs 10 credits at 2k or 4k resolution and 15 credits at 8k, and returns a task ID for status checks.

Input Parameters

string
Optional task name.
string ("meshy-5" | "meshy-6" | "meshy-7" | "latest")
Meshy model to use.
string ("realistic" | "cartoon")
Art style to apply to the generated texture.
string
HTTP(S) URL or data URI for a GLB, GLTF, OBJ, FBX, or STL model. Required when input_task_id is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
boolean
Whether to produce PBR texture maps.
string
Prior Meshy task containing the model to retexture. Required when model_url is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
array
Additional model formats to export.
boolean
Whether to produce a transparent-background preview thumbnail.
string
HTTP(S) URL or data URI for one style reference image. Provide at least one style source. Takes precedence over text_style_prompt when both are provided; text_style_prompt is omitted from the request. Cannot be combined with multiview_image_urls.
boolean
Whether to remove baked lighting from the texture; support depends on the selected model.
string
Text description of the desired style. Provide at least one style source. May be combined with image_style_url, which takes precedence and causes text_style_prompt to be omitted from the request. Cannot be combined with multiview_image_urls.
boolean
Whether to reuse the source model’s UV coordinates.
string ("2k" | "4k" | "8k")
Texture resolution tier. Meshy defaults to 2k when omitted; 8k consumes more credits.
array
One to four style reference views of the same object, primary view first. Requires ai_model=‘meshy-7’ and account entitlement; cannot be combined with text_style_prompt or image_style_url.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_RIGGING_TASKStart a 5-credit task that rigs a GLB character with a biped or quadruped skeleton and return the task ID. Models above 300,000 faces must be remeshed first.

Input Parameters

string
Optional task name.
string
HTTP(S) URL for the GLB model to rig. Required when input_task_id is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
number
Target character height in meters; must be greater than zero.
string
Prior Meshy task containing the GLB model to rig. Required when model_url is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
string ("biped" | "quadruped")
Skeleton type to create for the character.
string
Optional PNG texture as an HTTP(S) URL or base64 data URI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_TEXT_TO_3D_TASKStart a new Text to 3D preview or fused geometry-and-texture task and return its task ID. Preview costs 20 credits for Meshy 6/7, 5 credits for Meshy T2 or other models, and Ultra adds 5 credits; fused generation costs 30 credits for Meshy 6/7 or 15 for Meshy T2 and other models. Use REFINE_TEXT_TO_3D_TASK to texture a succeeded preview.

Input Parameters

string
Optional human-readable task name.
integer
Non-negative random seed. Use 0 to let Meshy randomize it.
integer
Number of candidates to generate, from 2 to 4. Not supported by meshy-t2 or fused generation.
string
required
Description of the object to generate.
string ("meshy-5" | "meshy-6" | "meshy-7" | "latest" | "meshy-t2")
Meshy model to use; meshy-7 and meshy-t2 require entitlement.
string
Optional client-supplied identifier for batch correlation.
string ("quad" | "triangle")
Output mesh topology. quad is not supported by meshy-t2.
string
Art style for the generated model.
boolean
Whether Meshy should estimate the model’s real-world size.
string ("bottom" | "center")
Place the generated model origin at its bottom or center.
string ("a-pose" | "t-pose")
Force an A-pose or T-pose for a character model.
boolean
Whether to produce physically based rendering texture maps.
string ("standard" | "lowpoly" | "smart-topology")
Generation pipeline. smart-topology selects the meshy-t2 model family.
boolean
Whether to run content moderation on this task.
boolean
Enable the entitled high-detail pass for a meshy-7 preview; this consumes additional credits.
object
Experimental fast-mode options that may change.
boolean
Whether to remesh after draft generation; the provider default depends on the model.
array
Additional model formats to export.
string
Description of the desired texture appearance.
boolean
Whether to produce a preview thumbnail with a transparent background.
integer ("1" | "2" | "3" | "4")
Meshy decimation algorithm selector from 1 through 4.
string ("preview" | "fused")
required
Required generation path. preview creates geometry only and costs 20 credits for Meshy 6/7 or 5 for Meshy T2 and other models; fused creates geometry and texture in one task and costs 30 or 15 credits, respectively.
string
Features or visual qualities that the generated object should avoid.
integer
Target polygon count from 100 to 300000; the provider chooses a model-specific default when omitted.
string ("none" | "low" | "medium" | "high")
Texture detail level.
string
HTTP(S) URL of an image to use as a texture reference.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_TEXT_TO_IMAGE_TASKStart a credit-consuming 2D image generation task from a text prompt. The task costs 3 to 9 credits depending on the model and returns a task ID for status checks.

Input Parameters

string
required
Text description of the image to generate.
string ("nano-banana" | "nano-banana-pro" | "nano-banana-2" | "gpt-image-2")
required
Meshy image model to use.
string ("a-pose" | "t-pose")
Force an A-pose or T-pose; this may upgrade the model and require a higher account tier.
string ("1:1" | "16:9" | "9:16" | "4:3" | "3:4" | "3:2" | "2:3")
Output aspect ratio. gpt-image-2 supports 1:1, 16:9, 9:16, 3:2, and 2:3; nano-banana models support 1:1, 16:9, 9:16, 4:3, and 3:4. Do not set this for multi-view generation.
boolean
Whether to return a transparent RGBA cutout. Available only for single-image generation.
boolean
Whether to produce one four-view split image instead of a single image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_TEXT_TO_MOTION_TASKStart an entitled motion-generation task from a text prompt and return its task ID. Prime mode costs 10 credits and the completed task produces FBX; swift mode costs 3 credits and the completed task produces BVH.

Input Parameters

string ("prime" | "swift")
Generation mode: prime costs 10 credits and the completed task produces FBX; swift costs 3 credits and the completed task produces BVH.
string
required
Description of the motion to generate, up to 400 characters.
number
required
Motion length from 2 to 10 seconds in 0.5-second increments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_CREATE_UV_UNWRAP_TASKStart a 5-credit task that generates UV coordinates for a GLB model and return the task ID. High-poly models may need to be remeshed first.

Input Parameters

string
GLB HTTP(S) URL or data URI. Required when input_task_id is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.
string
Prior Meshy task containing the GLB model. Required when model_url is omitted. When both sources are provided, input_task_id takes precedence and model_url is omitted from the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_DELETE_TASKDelete a GA or Text-to-Motion task and its retained outputs. A pending task is canceled and refunded; an in-progress task cannot be deleted until it reaches a terminal status.

Input Parameters

string
required
Provider task ID to permanently delete.
string ("text_to_3d" | "image_to_3d" | "multi_image_to_3d" | "retexture" | "remesh" | "convert" | "resize" | "uv_unwrap" | "rigging" | "animation" | "text_to_image" | "image_to_image" | "print_multi_color" | "print_repair" | "print_analyze" | "print_split" | "text_to_motion")
required
Permanently deletable GA or Text-to-Motion task family that owns the ID; selects a fixed documented endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_GET_CREDIT_BALANCEReturn the connected Meshy account’s available credit balance before starting paid generation tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_GET_TASKRetrieve current status, errors, and available outputs for one task from a selected Meshy task family. This read does not consume credits.

Input Parameters

string
required
Meshy task ID returned by a create or list call.
string
required
Task family that owns the ID. This selects one fixed documented endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_LIST_ANIMATION_LIBRARYSearch or filter Meshy’s unpaginated animation catalog and return action IDs for use when creating animation tasks.

Input Parameters

Literal case-insensitive substring to match against animation names or keys.
string ("WalkAndRun" | "BodyMovements" | "DailyActions" | "Fighting" | "Dancing")
Exact animation category to return.
array
One to 200 animation action IDs to return. Unknown IDs are omitted.
string
Exact animation sub-category; the same name may occur in multiple categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_LIST_TASKSReturn one page of tasks for a selected Meshy task family, with a cursor for continuing to the next page. This read does not consume credits.

Input Parameters

string ("+created_at" | "-created_at")
Sort by creation time: +created_at for oldest first or -created_at for newest first.
integer
Tasks in this page. The maximum is 100 for 30 explicitly documented families. UV Unwrap, Rigging, Animation, and Text to Motion are capped at the documented and provider-accepted value 20; Text to Motion’s exact provider maximum is not documented.
string
Exact Meshy task family to list. Required for the first page; omit it only when continuing with next_cursor.
string
Opaque cursor returned by a prior call. When continuing, send next_cursor as the only parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_LIST_USAGE_RECORDSReturn one page of terminal API-task usage and consumed credits for a Meshy team using a Studio or Enterprise team API key. Continue filtered exports with the cursor; pagination stops at page 255, so use smaller time windows for larger exports.

Input Parameters

string ("SUCCEEDED" | "FAILED")
Terminal status to include: SUCCEEDED or FAILED. Omit to include both.
string ("+created_at" | "-created_at")
Sort by creation time: +created_at for oldest first or -created_at for newest first.
string
End of the created_at window as an RFC3339 timestamp. Defaults to the current time.
array
Endpoint families to include. Meshy receives these as one comma-separated endpoints filter; text-to-3d includes preview and refine.
integer
Usage records in this page, from 1 through 100.
string
Start of the created_at window as an RFC3339 timestamp. Defaults to 30 days before end_time.
string
Opaque cursor returned by a prior call. When continuing, send next_cursor as the only parameter; the original filters are restored from it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MESHY_REFINE_TEXT_TO_3D_TASKApply texture to a succeeded Text to 3D preview and return the new refine task ID. Refinement costs 10 credits at 2k or 4k texture resolution and 15 credits at 8k.

Input Parameters

string ("meshy-5" | "meshy-6" | "meshy-7" | "latest")
Texture model. Omit to inherit the preview task’s model.
boolean
Estimate the model’s real-world height and resize it.
string ("bottom" | "center")
Place the origin at the bottom or center when auto_size is enabled.
boolean
Generate metallic, roughness, and normal maps in addition to base color.
boolean
Screen the texture prompt and reference image for harmful content.
array
Model formats to generate for the textured output.
string
Text guidance for the texture. If both texture guides are supplied, this takes precedence.
boolean
Also render a transparent-background preview thumbnail.
string
required
ID of a succeeded Text to 3D preview task whose mesh will be textured.
boolean
Remove highlights and shadows from base color; Meshy defaults this to true.
string
Public HTTP(S) URL or image data URI used to guide the texture.
string ("2k" | "4k" | "8k")
Texture resolution. Meshy defaults to 2k; 2k/4k cost 10 credits and 8k costs 15 credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not