Docs

Running a model

MeshyText to 3D

Meshy-6

High-fidelity 3D generation with cleaner geometry, low-poly workflows, and production-ready mesh control

POSTauray-serverless/meshy/meshy-6
openapi.jsonllms.txt

One of Auray's catalogue models: the same key, the same credits, the same job lifecycle as every other address.

Its request shape is published below. Whether it runs right now is GET /v1/catalogue's word, with no key needed: its addresses say connected for an address that runs, and a submit to any other is refused before anything is charged — described answers 501 model_not_connected, paused 503 model_disabled.

Category text-to-3d · Scope 3d:write (or external:write on an older key) · Price Credits per call (counted as settings.polyCount@30000): 67 for settings.meshType=standard, settings.texture=false; settings.meshType=standard, settings.texture=true; settings.meshType=lowpoly, settings.texture=false; settings.meshType=lowpoly, settings.texture=true. From 1 to 10 calls a request. Quoted when you submit, at the most the request can cost; the charge settles to what the job cost and never above the quote. The submit's answer carries the quote as credits_quoted, and credits_charged says what has been taken.

#Input

FieldTypeRequiredDefaultDescription
inputsobjectno—
inputs.referenceImagesstring[]no—List of reference images (an http(s) URL; upload a local file first and send its read URL). Used to guide the texturing process. Documented range: 1 to 1.
inputs.imagesstring[]no—Array of image inputs (an http(s) URL; upload a local file first and send its read URL). For single image-to-3D, provide 1 image. For multi-image-to-3D, provide 2–4 images. Documented range: 1 to 4.
positivePromptstringno—Text prompt describing elements to include in the generated output. Documented range: up to 600 characters.
settingsobjectno—
settings.autoSizebooleanno—AI-based real-world height estimation to resize the model accordingly.
settings.decimationintegerno—Adaptive decimation level. One of 1, 2, 3, 4.
settings.hdTexturebooleanno—Base colour texture at 4K (4096×4096) resolution. PBR maps are always generated at 2K regardless.
settings.imageEnhancementbooleannotrueInput image optimization for better generation results. Set to false to preserve the exact appearance of the input.
settings.meshTypestringno"standard"Mesh generation type for the output 3D model. One of "standard", "lowpoly".
settings.moderationbooleanno—Input content screening for potentially harmful material before generation proceeds. Always on: a false is sent as true.
settings.originstringno"bottom"Origin point position for the generated model. One of "bottom", "center".
settings.pbrbooleanno—PBR map generation (metallic, roughness, normal) in addition to base colour. Includes an emission map.
settings.polyCountintegerno30000Target polygon count. Actual count may deviate based on geometry complexity. Documented range: 100 to 300,000.
settings.posestringno"none"Pose preset for the generated model. One of "none", "a-pose", "t-pose".
settings.remeshbooleanno—Remesh phase toggle. When false, returns the highest-precision triangular mesh without decimation.
settings.removeLightingbooleannotrueHighlight and shadow removal from the base colour texture, producing a cleaner result for custom lighting.
settings.symmetrystringno"auto"Symmetry behaviour during generation. One of "off", "auto", "on".
settings.texturebooleannotrueTexture generation toggle. When false, returns a mesh only.
settings.texturePromptstringno—Additional text prompt to guide the texturing process. Documented range: up to 600 characters.
settings.topologystringno"triangle"Mesh topology for the output model. One of "triangle", "quad".
outputTypestringno"URL"3D output type. One of "URL".
outputFormatstringno"GLB"Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities. - `JPG`: Best for photorealistic images with smaller file sizes (no transparency). - `PNG`: Lossless compression, supports high quality and transparency (alpha channel). - `WEBP`: Modern format providing superior compression and transparency support. - `MP4`: Widely supported video container (H.264), recommended for general use. - `WEBM`: Optimized for web delivery. - `MOV`: QuickTime format, common in professional workflows (Apple ecosystem). - `GIF`: Animated image format (no audio), suitable for short loops or previews. - `MP3`: Compressed audio, smaller file size. - `WAV`: Uncompressed, high-quality audio. - `FLAC`: Lossless compression. - `OGG`: Open-source compressed audio format (Vorbis codec). - `SVG`: Scalable Vector Graphics. - `TIFF`: High-quality output supporting layers. - `GLB`: Binary glTF format for 3D models, including geometry, textures, and PBR materials. > [!NOTE] > **Transparency**: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., `PNG`, `WEBP`, `TIFF`). `JPG` does not support transparency. One of "GLB".
idempotency_keystringno—Your own name for this request. Send the same one twice and the second call is answered with the first request rather than charged again. Idempotency-Key: as a header is accepted as an alias — that is the spelling a retrying proxy replays, and the one to use when running a model on auray.run, where a request that outlives its connection is answered 504 and recovered by replay. Omit it and the platform mints one. 1 to 64 characters.

#Rules

Across fields, as the model's documentation states them. Each is judged before anything is charged — warned with a Deprecation header until enforcement starts — and listed as JSON Schema under x-auray-rules in the openapi.json.

  • Do not send settings.polyCount together with settings.decimation.
  • Do not send settings.texturePrompt together with inputs.referenceImages.
  • When settings.meshType is "lowpoly", do not send a request where settings.remesh is sent, or where settings.topology is sent, or where settings.polyCount is sent, or where settings.decimation is sent.
  • When settings.texture is false, do not send settings.pbr.
  • When settings.origin is sent, settings.autoSize must be true.
  • When settings.topology is sent, settings.polyCount is sent or settings.decimation is sent, settings.remesh must be true.
  • When settings.imageEnhancement is sent, inputs.images is required.
  • Send exactly one of positivePrompt or inputs.images.

#Example

curl -X POST https://queue.auray.run/auray-serverless/meshy/meshy-6 \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left"
}'

The same body on https://auray.run runs synchronously and answers the result — unless it usually takes longer than a run may hold its connection, which is refused 400 model_not_synchronous before anything is charged. Options — ?webhook=, ?wait=, priority and timeout headers — are on Submit a request.

#Machine contracts

  • openapi.json — this page as an OpenAPI 3.1 document, public.
  • llms.txt — the same, written for an agent.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close