Text To 3D Beta API

Text To 3D API is a feature that allows you to integrate Meshy's Text to 3D capabilities into your own application. In this section, you'll find all the information you need to get started with this API.

The Text to 3D Task Model

The Text to 3D Task model is a work unit that Meshy keeps track of to generate a 3D model from a text input. The model has the following properties:

Properties

Name
id
Type
string
Description
Unique identifier for the task. While we use a k-sortable UUID for task ids as the implementation detail, you should not make any assumptions about the format of the id.
Name
model_urls
Type
object
Description
Downloadable URL to the textured 3D model file generated by Meshy.
- Name
  glb
  Type
  string
  Description
  Downloadable URL to the GLB file.
- Name
  fbx
  Type
  string
  Description
  Downloadable URL to the FBX file.
- Name
  usdz
  Type
  string
  Description
  Downloadable URL to the USDZ file.
- Name
  obj
  Type
  string
  Description
  Downloadable URL to the OBJ file.
- Name
  mtl
  Type
  string
  Description
  Downloadable URL to the MTL file.
Name
prompt
Type
string
Description
This is unmodified prompt that was used to create the task.
Name
negative_prompt
Type
string
Description
This is unmodified negative_prompt that was used to create the task.
Name
art_style
Type
string
Description
This is unmodified art_style that was used to create the preview task.
Name
texture_richness
Type
string
Description
This is unmodified texture_richness that was used to create the refine task.
Name
thumbnail_url
Type
string
Description
Downloadable URL to the thumbnail image of the model file.
Name
video_url
Type
string
Description
Downloadable URL to the preview video.
Name
progress
Type
integer
Description
Progress of the task. If the task is not started yet, this property will be 0. Once the task has succeeded, this will become 100.
Name
started_at
Type
timestamp
Description
Timestamp of when the task was started, in miliseconds. If the task is not started yet, this property will be 0.
A timestamp represents the number of milliseconds elapsed since January 1, 1970 UTC, following the RFC 3339 standard. For example, Friday, September 1, 2023 12:00:00 PM GMT is represented as 1693569600000. This applies to all timestamps in Meshy API.
Name
created_at
Type
timestamp
Description
Timestamp of when the task was created, in miliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp of when the task was finished, in miliseconds. If the task is not finished yet, this property will be 0.
Name
status
Type
string
Description
Status of the task. Possible values are one of PENDING, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.
Name
task_error
Type
object
Description
Error object that contains the error message if the task failed. The message property should be empty if the task succeeded.
- Name
  message
  Type
  string
  Description
  Detailed error message.
Name
texture_urls
Type
array
Description
An array of texture URL objects that are generated from the task. Normally this only contains one texture URL object. Each texture URL has the following properties:
If the task is created with art_style: "voxel", this property will be an empty list.
- Name
  base_color
  Type
  string
  Description
  Downloadable URL to the base color map image.
Name
preceding_tasks
Type
integer
Description
The count of preceding tasks.
The value of this field is meaningful only if the task status is PENDING.

Example Text to 3D Task Model

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "art_style": "realistic",
  "negative_prompt": "low quality, low resolution, low poly, ugly",
  "progress": 1,
  "seed": 1234,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ]
}

POST/v2/text-to-3d

Create a Text to 3D Preview Task

This endpoint allows you to create a new Text to 3D Preview task. Refer to The Text to 3D Task Model to see which properties are included with Text to 3D task object.

Parameters

Required attributes

Name
mode
Type
string
Description
This field should be set to "preview" when creating a preview task.
Name
prompt
Type
string
Description
Describe what kind of object the 3D model is.

Optional attributes

Name
negative_prompt
Type
string
Description
Describe what the model should not look like.
Name
art_style
Type
string
Description
Describe your desired art style of the object. Default to realistic if not specified. Available values:
- realistic: Realistic style
- cartoon: Cartoon style
- low-poly: Low Poly style
- sculpture: Sculpture style
- pbr: PBR style
When you are using meshy-4 ai_model, only realistic, sculpture and pbr are available.
Name
seed
Type
integer
Description
When you use the same prompt and seed, you will generate the same result.
Name
ai_model
Type
string
Description
ID of the model to use. Default to meshy-4 if not specified. Available values:
- meshy-4
- meshy-3-turbo
- meshy-3
The refine task will use the same model as the corresponding preview task.
Name
topology
Type
string
Description
Specify the topology of the generated model. Default to triangle if not specified. Available values:
- quad: Generate a quad-dominant mesh.
- triangle: Generate a decimated triangle mesh.
This parameter is effective only if ai_model is set to meshy-4.
Name
target_polycount
Type
integer
Description
Specify the target number of polygons in the generated model. The actual number of polygons may deviate from the target depending on the complexity of the geometry.
The valid value range varies depending on the user tier:
- Premium users: 3,000 to 100,000 (inclusive)
- Free users: 10,000 to 30,000 (inclusive)
Default to 30,000 if not specified.
This parameter is effective only if ai_model is set to meshy-4.

Returns

The result property of the response contains the task id of the newly created Text to 3D task.

Request

POST

/v2/text-to-3d

curl https://api.meshy.ai/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask",
  "art_style": "realistic",
  "negative_prompt": "low quality, low resolution, low poly, ugly"
}'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

POST/v2/text-to-3d

Create a Text to 3D Refine Task

This endpoint allows you to create a new Text to 3D Refine task.

Parameters

Required attributes

Name
mode
Type
string
Description
This field should be set to "refine" when creating a preview task.
Name
preview_task_id
Type
string
Description
The corresponding preview task id. The status of the given preview task must be SUCCEEDED.

Optional attributes

Name
texture_richness
Type
string
Description
Describe your desired texture richness. Available values:
- high
- medium
- low
- none
The default value of texture_richness depends on the corresponding preview task's art style:
- high for realistic
- medium for cartoon
- none for low-poly

This parameter has no effect when ai_model is set to meshy-4.

Returns

The result property of the response contains the task id of the newly created Text to 3D task.

Request

POST

/v2/text-to-3d

curl https://api.meshy.ai/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
}'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/v2/text-to-3d/:id

Retrieve a Text to 3D Task

This endpoint allows you to retrieve a Text to 3D task given a valid task id. Refer to The Text to 3D Task Model to see which properties are included with Text to 3D task object.

Parameters

Name
id
Type
path
Description
Unique identifier for the Text to 3D task to retrieve.

Returns

The response contains the Text to 3D task object. Check The Text to 3D Task Model section for details.

Request

GET

/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "art_style": "realistic",
  "negative_prompt": "low quality, low resolution, low poly, ugly",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ]
}