La API de Imagen a 3D es una función que te permite integrar las capacidades de Imagen a 3D de Meshy en tu propia aplicación. En esta sección, encontrarás toda la información
que necesitas para empezar a usar esta API.
Este endpoint te permite crear una nueva tarea Imagen a 3D. Consulta
El objeto de tarea Imagen a 3D para ver qué
propiedades se incluyen con el objeto de tarea Imagen a 3D.
Parámetros
Solo se requiere uno de input_task_id o image_url. Si se proporcionan ambos, input_task_id tiene prioridad.
Name
input_task_id
Type
string
Requerido
Description
El ID de una tarea de generación de imágenes completada cuya salida debe usarse como imagen de entrada. Esta tarea debe ser una de las siguientes: Texto a imagen o Imagen a imagen. Además, debe haberse ejecutado mediante la API, tener un estado SUCCEEDED y producir exactamente una imagen.
Name
image_url
Type
string
Requerido
Description
Proporciona una imagen para que Meshy la use en la creación del modelo. Actualmente admitimos los formatos .jpg, .jpeg y .png.
Hay dos formas de proporcionar la imagen:
URL accesible públicamente: Una URL accesible desde Internet público.
Data URI: Un Data URI codificado en base64 de la imagen. Ejemplo de un Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
model_type
Type
string
predeterminado standard
Description
Especifica el tipo de generación de malla 3D.
Valores disponibles:
standard: Generación de malla 3D normal de alto detalle.
lowpoly: Genera una malla low-poly optimizada para polígonos más limpios.
Cuando se selecciona lowpoly, ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model se ignoran.
Name
ai_model
Type
string
predeterminado latest
Description
ID del modelo que se va a usar. Valores disponibles: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
predeterminado true
Description
Determina si se generan texturas. Establecerlo en false omite la fase de textura, proporcionando una malla sin texturas.
Solo aplica cuando should_texture = true
Name
enable_pbr
Type
boolean
predeterminado false
Description
Genera mapas PBR (metálico, rugosidad, normal) además del color base. También se incluye un mapa de emisión cuando ai_model es meshy-6 o latest.
Name
hd_texture
Type
boolean
predeterminado false
Description
Genera la textura de color base a resolución 4K (4096×4096) para mayor detalle.
Solo se admite cuando ai_model es meshy-6 o latest. Los mapas PBR siempre se generan a 2K.
Name
texture_prompt
Type
string
Description
Proporciona un prompt de texto para guiar el proceso de texturizado. Máximo 600 caracteres.
Name
texture_image_url
Type
string
Description
Proporciona una imagen 2D para guiar el proceso de texturizado. Actualmente admitimos los formatos .jpg, .jpeg y .png.
Hay dos formas de proporcionar la imagen:
URL accesible públicamente: Una URL accesible desde Internet público
Data URI: Un Data URI codificado en base64 de la imagen. Ejemplo de un Data URI: data:image/jpeg;base64,<your base64-encoded image data>
El texturizado con imagen puede no funcionar de forma óptima si hay diferencias sustanciales de geometría entre el asset original y la imagen subida. Solo uno de texture_image_url o texture_prompt puede usarse para guiar el proceso de texturizado. Si se proporcionan ambos parámetros, entonces texture_prompt se usará para texturizar el modelo de forma predeterminada. Texturizar mediante texto o imagen costará 10 créditos por tarea.
Name
should_remesh
Type
boolean
predeterminado false (meshy-6), true (others)
Description
Controla si se habilita la fase de remallado (remesh). Cuando se establece en false, la API devuelve la malla triangular de mayor precisión.
Solo aplica cuando should_remesh = true
Name
topology
Type
string
predeterminado triangle
Description
Especifica la topology del modelo generado.
Valores disponibles:
quad: Genera una malla con predominio de cuadriláteros.
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:
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, target_polycount se ignora.
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
save_pre_remeshed_model
Type
boolean
predeterminado false
Description
Cuando se establece en true, Meshy también almacena un archivo GLB adicional antes de que se complete la fase de remallado (remesh).
Name
symmetry_mode
Type
string
⚠ obsoleto
predeterminado auto
Description
Obsoleto (deprecated). Este parámetro ya no afecta a la salida.
El campo symmetry_mode controla el comportamiento de simetría durante el proceso de generación del modelo.
Los valores válidos son:
off: Desactiva la simetría.
auto: Determina y aplica automáticamente la simetría en función de la geometría de entrada.
on: Fuerza la simetría durante la generación.
Name
pose_mode
Type
string
predeterminado ""
Description
Especifica el pose_mode para el modelo generado.
Valores disponibles:
a-pose: Genera el modelo en una pose A.
t-pose: Genera el modelo en una pose T.
"" (cadena vacía): No se aplica ninguna pose específica.
Name
is_a_t_pose
Type
boolean
⚠ obsoleto
predeterminado false
Description
Usa pose_mode en su lugar. Indica si se debe generar el modelo en una pose A/T.
Name
image_enhancement
Type
boolean
predeterminado true
Description
Optimiza la imagen de entrada para obtener mejores resultados. Establécelo en false para conservar la apariencia exacta de la imagen de entrada sin ningún procesamiento de estilo.
Solo se admite cuando ai_model es meshy-6 o latest.
Name
remove_lighting
Type
boolean
predeterminado true
Description
Elimina reflejos y sombras de la textura de color base, produciendo un resultado más limpio que funciona mejor con configuraciones de iluminación personalizadas.
Solo se admite cuando ai_model es meshy-6 o latest.
Name
moderation
Type
boolean
predeterminado false
Description
Cuando se establece en true, el contenido de entrada se revisará automáticamente para detectar contenido potencialmente dañino. Si se detecta contenido dañino, la tarea no continuará con la generación.
Se revisará el contenido de las entradas image_url, texture_image_url y texture_prompt.
Name
target_formats
Type
string[]
Description
Especifica qué formatos de archivo 3D se deben incluir en la salida. Solo se generarán y devolverán los formatos solicitados, lo que puede reducir el tiempo de finalización de la tarea. Cuando se omite, se incluyen todos los formatos admitidos.
Cuando se omite, se generan todos los formatos excepto 3mf. 3mf solo se incluye cuando se especifica explícitamente.
Name
auto_size
Type
boolean
predeterminado false
Description
Cuando se establece en true, el servicio usa visión de IA para estimar automáticamente la altura real del objeto y redimensionar el modelo en consecuencia. El origen se establecerá de forma predeterminada en bottom a menos que origin_at se establezca explícitamente.
Name
alpha_thumbnail
Type
boolean
predeterminado false
Description
Cuando se establece en true, la tarea renderiza adicionalmente una versión con fondo transparente (RGBA) de la vista previa y la devuelve como alpha_thumbnail_url en la respuesta GET. El campo existente thumbnail_url no cambia.
Name
multi_view_thumbnails
Type
boolean
predeterminado false
Description
Cuando se establece en true, la tarea renderiza adicionalmente cuatro miniaturas de vistas cardinales (frontal, derecha, posterior, izquierda) y las devuelve bajo thumbnail_urls en la respuesta GET. El campo existente thumbnail_url no cambia y sigue apuntando a la vista frontal, por lo que los clientes existentes no se ven afectados.
Añade aproximadamente 3 segundos a la latencia de la tarea.
Solo aplica cuando auto_size = true
Name
origin_at
Type
string
predeterminado bottom
Description
Posición del origen cuando auto_size está habilitado.
Valores disponibles: bottom, center.
Devuelve
La propiedad result de la respuesta contiene el id de la tarea Imagen a 3D recién creada.
Modos de fallo
Name
400 - Bad Request
Description
La solicitud no era aceptable. Causas comunes:
Parámetro faltante: Se debe proporcionar image_url o input_task_id.
Tarea de entrada no válida: El input_task_id debe hacer referencia a una tarea Texto a imagen o Imagen a imagen con estado SUCCEEDED que produzca exactamente una imagen.
Formato de imagen no válido: El image_url proporcionado no tiene un formato admitido (.jpg, .jpeg, .png).
URL inalcanzable: No se pudo descargar el image_url (404 o timeout).
Data URI no válido: La cadena base64 está mal formada.
Combinación de parámetros no válida: enable_pbr solo se admite cuando should_texture es true.
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 superado tu límite de tasa.
Request
POST
/openapi/v1/image-to-3d
# Simple request with required paramscurl https://api.meshy.ai/openapi/v1/image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'# With remesh, PBR, and A-posecurl https://api.meshy.ai/openapi/v1/image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Este endpoint te permite recuperar una tarea de Imagen a 3D dado un id de tarea válido.
Consulta El objeto de tarea de Imagen a 3D para ver qué
propiedades se incluyen con el objeto de tarea de Imagen a 3D.
Parámetros
Name
id
Type
path
Description
Identificador único de la tarea de Imagen a 3D que se va a recuperar.
Devuelve
La respuesta contiene el objeto de tarea de Imagen a 3D. Consulta la sección
El objeto de tarea de Imagen a 3D para obtener más detalles.
El objeto de tarea de Imagen a 3D es una unidad de trabajo que Meshy rastrea para generar un modelo 3D a partir de una entrada de imagen.
El objeto tiene las siguientes propiedades:
Propiedades
Name
id
Type
string
Description
Identificador único de la tarea. Aunque usamos un UUID ordenable por k para los ids de tarea como
detalle de implementación, no debes hacer ninguna suposición sobre el formato del id.
Name
type
Type
string
Description
Tipo de la tarea de Imagen a 3D. El valor es image-to-3d.
Name
model_urls
Type
object
Description
URL descargable del archivo de 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
mtl
Type
string
Description
URL descargable del archivo MTL, devuelto junto con las exportaciones OBJ cuando hay texturas presentes.
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
pre_remeshed_glb
Type
string
Description
URL descargable de la salida GLB original antes del remallado.
Disponible solo cuando la tarea se creó con should_remesh: true y save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL descargable de la imagen de miniatura del archivo de modelo. Equivalente a thumbnail_urls.front cuando está presente, se mantiene por compatibilidad con versiones anteriores.
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
thumbnail_urls
Type
object
Description
URLs descargables para cuatro miniaturas de vistas cardinales del modelo 3D generado. Cada valor es una URL firmada a un PNG de 512×512 renderizado con los mismos materiales e iluminación que thumbnail_url. Útil para previsualizar el modelo desde varios ángulos en pipelines por lotes sin descargar el GLB.
Solo está presente cuando la tarea se creó con multi_view_thumbnails: true y ha alcanzado SUCCEEDED. Las tareas anteriores y las tareas creadas sin la suscripción no incluirán este campo.
Name
front
Type
string
Description
Vista frontal, rotación de 0° alrededor del eje vertical (coincide con thumbnail_url).
Name
right
Type
string
Description
Vista derecha, rotación de 90°.
Name
back
Type
string
Description
Vista posterior, rotación de 180°.
Name
left
Type
string
Description
Vista izquierda, rotación de 270°.
Name
texture_prompt
Type
string
Description
El prompt de texto que se usó para guiar el proceso de texturizado.
Name
texture_image_url
Type
string
Description
URL descargable de la imagen de textura que se usó para guiar el proceso de texturizado.
Name
progress
Type
integer
Description
Progreso 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
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.
Una marca de tiempo representa el número de milisegundos transcurridos desde el 1 de enero de 1970 UTC, siguiendo
el estándar RFC 3339.
Por ejemplo, viernes, 1 de septiembre de 2023 12:00:00 PM GMT se representa como 1693569600000. Esto se aplica
a todas las marcas de tiempo en Meshy API.
Name
created_at
Type
timestamp
Description
Marca de tiempo de cuando se creó la tarea, en milisegundos.
Name
expires_at
Type
timestamp
Description
Marca de tiempo de cuando expira el resultado de la tarea, en milisegundos.
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
status
Type
string
Description
Estado de la tarea. Los valores posibles son uno de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Un array de objetos de URL de textura que se generan a partir de la tarea. Normalmente esto solo contiene un objeto de URL de textura. Cada URL de textura tiene las siguientes propiedades:
Name
base_color
Type
string
Description
URL descargable de la imagen de mapa de color base.
Name
metallic
Type
string
Description
URL descargable de la imagen de mapa metálico.
Si la tarea se crea con enable_pbr: false, esta propiedad se omitirá.
Name
normal
Type
string
Description
URL descargable de la imagen de mapa de normales.
Si la tarea se crea con enable_pbr: false, esta propiedad se omitirá.
Name
roughness
Type
string
Description
URL descargable de la imagen de mapa de rugosidad.
Si la tarea se crea con enable_pbr: false, esta propiedad se omitirá.
Name
emission
Type
string
Description
URL descargable de la imagen de mapa de emisión.
Si la tarea se crea con enable_pbr: false, o ai_model es meshy-5, esta propiedad se omitirá.
Name
preceding_tasks
Type
integer
Description
El recuento de tareas precedentes.
El valor de este campo solo es significativo si el estado de la tarea es PENDING.
Name
task_error
Type
object
Description
Detalles del error para tareas fallidas. Consulta Errores para obtener la referencia completa del objeto task_error.
Name
consumed_credits
Type
integer
Description
El número de créditos consumidos por esta tarea. Presente cuando el estado de la tarea es PENDING, IN_PROGRESS o SUCCEEDED. Devuelve 0 para tareas FAILED (los créditos se reembolsan en caso de fallo).