API de Remallado

La API de Remallado te permite remallar y exportar modelos 3D existentes generados por otras API de Meshy (como Imagen a 3D o Texto a 3D) a diversos formatos. Esta sección proporciona detalles sobre cómo usar la API de Remallado.


POST/openapi/v1/remesh

Crear una tarea de Remallado

Este endpoint crea una nueva tarea de remallado (remesh).

Parámetros

  • Name
    input_task_id
    Type
    string
    Requerido
    Description

    El ID de la tarea completada de Imagen a 3D o Texto a 3D que deseas remallar. Esta tarea debe ser una de las siguientes tareas: Vista previa de Texto a 3D, Refinamiento de Texto a 3D, Imagen a 3D o Retexturizar. Además, debe tener un estado de SUCCEEDED.

  • Name
    model_url
    Type
    string
    Requerido
    Description

    Proporciona un modelo 3D para que Meshy lo remalle mediante una URL de acceso público o un Data URI. Formatos compatibles: .glb, .gltf, .obj, .fbx, .stl.

    Para Data URI, usa el MIME type: application/octet-stream.

  • Name
    target_formats
    Type
    string[]
    predeterminado ["glb"]
    Description

    Una lista de formatos de destino para el modelo remallado. Cuando se omite, solo se genera GLB.

    Valores disponibles: glb, fbx, obj, usdz, blend, stl, 3mf.

  • Name
    topology
    Type
    string
    predeterminado triangle
    Description

    Especifica la topology del modelo generado.

    Valores disponibles:

    • quad: Genera una malla predominantemente de cuadrángulos.
    • triangle: Genera una malla triangular decimada.
  • Name
    target_polycount
    Type
    integer
    predeterminado 30,000
    Description

    Especifica el número objetivo de polígonos en el modelo generado. El número real de polígonos puede desviarse del objetivo según la complejidad de la geometría.

    El rango de valores válido varía según el nivel de usuario:

    • De 100 a 300,000 (inclusive)
  • Name
    decimation_mode
    Type
    integer
    Description

    Habilita la decimación adaptativa estableciendo un nivel de recuento de polígonos. Cuando se establece, se ignora target_polycount.

    Valores disponibles:

    • 1: Adaptativo — recuento de polígonos ultra.
    • 2: Adaptativo — recuento de polígonos alto.
    • 3: Adaptativo — recuento de polígonos medio.
    • 4: Adaptativo — recuento de polígonos bajo.
  • Name
    resize_height
    Type
    number
    obsoleto
    predeterminado 0
    Description

    Redimensiona el modelo a una altura determinada medida en metros. Recomendamos usar la API de Redimensionar dedicada en su lugar.

  • Name
    resize_longest_side
    Type
    number
    obsoleto
    predeterminado 0
    Description

    Redimensiona el modelo para que la dimensión más larga de la caja delimitadora sea igual al valor especificado en metros. Recomendamos usar la API de Redimensionar dedicada en su lugar.

  • Name
    auto_size
    Type
    boolean
    obsoleto
    predeterminado false
    Description

    Cuando se establece en true, el servicio utiliza visión de IA para estimar automáticamente la altura real del objeto y redimensionar el modelo en consecuencia. Recomendamos usar la API de Redimensionar dedicada en su lugar.

Solo aplica cuando auto_size = true
  • Name
    origin_at
    Type
    string
    obsoleto
    predeterminado bottom
    Description

    Posición del origen. Recomendamos usar la API de Redimensionar dedicada en su lugar.

    Valores disponibles: bottom, center.

  • Name
    convert_format_only
    Type
    boolean
    obsoleto
    Description

    Si es true, el servicio solo cambiará el formato del archivo del modelo de entrada, ignorando otras entradas como topology, resize_height y target_polycount. Recomendamos usar la API de Convertir dedicada en su lugar.

  • Name
    alpha_thumbnail
    Type
    boolean
    predeterminado false
    Description

    Cuando se establece en true, la tarea renderiza además una versión con fondo transparente (RGBA) de la vista previa y la devuelve como alpha_thumbnail_url en la respuesta GET. El campo thumbnail_url existente no cambia.

Devuelve

La propiedad result de la respuesta contiene el id de la tarea de remallado (remesh) recién creada.

Modos de fallo

  • Name
    400 - Bad Request
    Description

    La solicitud no era aceptable. Causas comunes:

    • Parámetro faltante: Se debe proporcionar model_url o input_task_id.
    • Tarea de entrada no válida: El input_task_id debe hacer referencia a una tarea exitosa de un modelo compatible.
    • Formato de modelo no válido: El model_url apunta a un archivo con una extensión no compatible.
    • URL inaccesible: El model_url no se pudo descargar.
    • Topology no válida: El parámetro topology no es válido.
    • Parámetros mutuamente excluyentes: auto_size y resize_height no pueden establecerse ambos.
  • Name
    401 - Unauthorized
    Description

    La autenticación falló. Comprueba tu clave de API.

  • Name
    402 - Payment Required
    Description

    Créditos insuficientes para realizar esta tarea.

  • Name
    429 - Too Many Requests
    Description

    Has excedido tu límite de tasa.

Request

POST
/openapi/v1/remesh
# Basic remesh with custom formats and resize
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["glb", "fbx"],
    "topology": "quad",
    "target_polycount": 50000,
    "resize_height": 1.0,
    "origin_at": "bottom"
  }'

# Quad remesh with auto-size
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["glb", "fbx"],
    "topology": "quad",
    "target_polycount": 50000,
    "auto_size": true
  }'

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}

GET/openapi/v1/remesh/:id

Recuperar una tarea de Remallado

Este endpoint recupera una tarea de remallado (remesh) por su ID.

Parámetros

  • Name
    id
    Type
    path
    Description

    El ID de la tarea de remallado (remesh) que se va a recuperar.

Devuelve

El objeto de tarea de Remallado.

Request

GET
/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
}

DELETE/openapi/v1/remesh/:id

Eliminar una tarea de Remallado

Este endpoint elimina permanentemente una tarea de remallado (remesh), incluidos todos los modelos y datos asociados. Esta acción es irreversible.

Parámetros de ruta

  • Name
    id
    Type
    path
    Description

    El ID de la tarea de remallado (remesh) que se va a eliminar.

Devuelve

Devuelve 200 OK si se realiza correctamente.

Request

DELETE
/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v1/remesh

Listar tareas de Remallado

Este endpoint te permite recuperar una lista de tareas de Remallado.

Parámetros

  • Name
    page_num
    Type
    integer
    predeterminado 1
    Description

    Número de página para la paginación.

  • Name
    page_size
    Type
    integer
    predeterminado 10
    Description

    Límite de tamaño de página. El máximo permitido es de 50 elementos.

  • Name
    sort_by
    Type
    string
    Description

    Campo por el que ordenar.

    Valores disponibles:

    • +created_at: Ordenar por hora de creación en orden ascendente.
    • -created_at: Ordenar por hora de creación en orden descendente.

Respuesta

Devuelve una lista paginada de los objetos de tarea de Remallado.

Request

GET
/openapi/v1/remesh
curl https://api.meshy.ai/openapi/v1/remesh?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "remesh",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null
  }
]
GET/openapi/v1/remesh/:id/stream

Transmitir una tarea de Remallado

Este endpoint transmite actualizaciones en tiempo real para una tarea de Remallado usando Server-Sent Events (SSE).

Parámetros

  • Name
    id
    Type
    path
    Description

    Identificador único de la tarea de Remallado que se va a transmitir.

Devuelve

Devuelve un flujo de Los objetos de tarea de Remallado como Server-Sent Events.

Para tareas PENDING o IN_PROGRESS, el flujo de respuesta solo incluirá los campos necesarios progress y status.

Request

GET
/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
curl -N https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
    "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
}

Objeto de tarea de Remallado

El objeto de tarea de Remallado representa una unidad de trabajo que Meshy utiliza para remallar y exportar un modelo 3D existente a varios formatos. El objeto tiene las siguientes propiedades:

Propiedades

  • Name
    id
    Type
    string
    Description

    Identificador único de la tarea. Aunque usamos un UUID ordenable por clave k para los id de tarea como detalle de implementación, no debes hacer suposiciones sobre el formato del id.

  • Name
    type
    Type
    string
    Description

    Tipo de la tarea de Remallado. El valor es remesh.

  • Name
    model_urls
    Type
    object
    Description

    URL descargable del archivo del modelo 3D con textura generado por Meshy. La propiedad de un formato se omitirá si el formato no se genera, en lugar de devolver una cadena vacía.

    • Name
      glb
      Type
      string
      Description

      URL descargable del archivo GLB.

    • Name
      fbx
      Type
      string
      Description

      URL descargable del archivo FBX.

    • Name
      obj
      Type
      string
      Description

      URL descargable del archivo OBJ.

    • Name
      usdz
      Type
      string
      Description

      URL descargable del archivo USDZ.

    • Name
      blend
      Type
      string
      Description

      URL descargable del archivo Blender.

    • Name
      stl
      Type
      string
      Description

      URL descargable del archivo STL.

    • Name
      3mf
      Type
      string
      Description

      URL descargable del archivo 3MF. Solo está presente cuando se solicitó 3mf mediante target_formats.

  • Name
    thumbnail_url
    Type
    string
    Description

    URL descargable de una imagen de vista previa renderizada a partir del modelo remallado.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    URL descargable de una versión con fondo transparente (RGBA) de thumbnail_url. Solo está presente cuando la tarea se creó con alpha_thumbnail: true y la vista previa transparente se renderizó correctamente; de lo contrario, este campo se omite.

  • Name
    progress
    Type
    integer
    Description

    progress de la tarea. Si la tarea aún no ha comenzado, esta propiedad será 0. Una vez que la tarea se haya completado correctamente, pasará a ser 100.

  • Name
    status
    Type
    string
    Description

    Estado de la tarea. Los valores posibles son uno de PENDING, IN_PROGRESS, SUCCEEDED, FAILED.

  • Name
    preceding_tasks
    Type
    integer
    Description

    El número de tareas precedentes.

  • Name
    created_at
    Type
    timestamp
    Description

    Marca de tiempo de cuando se creó la tarea, en milisegundos.

  • Name
    started_at
    Type
    timestamp
    Description

    Marca de tiempo de cuando se inició la tarea, en milisegundos. Si la tarea aún no ha comenzado, esta propiedad será 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Marca de tiempo de cuando finalizó la tarea, en milisegundos. Si la tarea aún no ha finalizado, esta propiedad será 0.

  • Name
    task_error
    Type
    object
    Description

    Detalles del error para las tareas fallidas. Consulta Errores para ver la referencia completa del objeto task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    El número de créditos consumidos por esta tarea. Está presente cuando el estado de la tarea es PENDING, IN_PROGRESS o SUCCEEDED. Devuelve 0 para las tareas FAILED (los créditos se reembolsan en caso de fallo).

Example Remesh Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5
}