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 comenzar a usar esta API.
Este endpoint le permite crear una nueva tarea de Imagen a 3D. Consulte
El objeto de tarea de Imagen a 3D para ver qué
propiedades se incluyen en el objeto de tarea de 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 a través de la API, tener un estado SUCCEEDED y producir exactamente una imagen.
Name
image_url
Type
string
Requerido
Description
Proporcione 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 de acceso público: una URL accesible desde internet públicamente.
Data URI: un data URI de la imagen codificado en base64. Ejemplo de un data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
model_type
Type
string
predeterminado standard
Description
Especifique el tipo de generación de malla 3D.
Valores disponibles:
standard: Generación de malla 3D regular de alto detalle.
smart-topology: Elija un modelo de Smart Topology con ai_model (meshy-t2).
lowpoly (obsoleto): Genera una malla low-poly optimizada para polígonos más limpios. Recomendamos usar smart-topology en su lugar.
Cuando se selecciona smart-topology, se ignoran topology, should_remesh y save_pre_remeshed_model.
Cuando se selecciona lowpoly, se ignoran ai_model, topology, target_polycount, should_remesh y save_pre_remeshed_model.
Name
ai_model
Type
string
predeterminado latest
Description
ID del modelo a usar. Los valores disponibles dependen de model_type.
meshy-t2 (predeterminado): el modelo de Smart Topology, con topology más limpia, partes separadas de forma nativa, salida en triángulos y un recuento de caras que puede establecer con target_polycount.
Name
geometry_resolution
Type
string
predeterminado standard
Description
Pase de generación de geometría. 2k ejecuta el pase Ultra a 2048³; 4k lo ejecuta a 4096³ para
el detalle de superficie más fino.
Valores disponibles: standard, 2k, 4k
Requiere meshy-7.1 o latest.
Name
ultra_mode
Type
boolean
⚠ obsoleto
predeterminado false
Description
Use geometry_resolution en su lugar. ultra_mode: true es equivalente a geometry_resolution: "2k".
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 (metallic, roughness, normal) además del color base. También se incluye un mapa de emisión cuando ai_model es meshy-6, excepto en texture_resolution: 8k. meshy-6-lite, meshy-7.1 y latest no producen un mapa de emisión.
Name
texture_resolution
Type
string
predeterminado 2k
Description
Resolución de la textura de color base. Uno de 2k (2048×2048), 4k (4096×4096) o 8k (8192×8192). Las resoluciones más altas capturan más detalle de superficie.
4k y 8k no están disponibles con ai_modelmeshy-6-lite. En 8k, no se produce ningún mapa de emisión.
Name
hd_texture
Type
boolean
⚠ obsoleto
predeterminado false
Description
Use texture_resolution en su lugar; equivale a texture_resolution: "4k". Cuando se configuran ambos, texture_resolution tiene prioridad.
Name
texture_prompt
Type
string
Description
Proporcione un prompt de texto para guiar el proceso de texturizado. Máximo 800 caracteres.
Name
texture_image_url
Type
string
Description
Proporcione 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 de acceso público: una URL accesible desde internet públicamente
Data URI: un data URI de la imagen codificado en base64. Ejemplo de un data URI: data:image/jpeg;base64,<your base64-encoded image data>
El texturizado por imagen puede no funcionar de forma óptima si existen diferencias sustanciales de geometría entre el asset original y la imagen subida. Solo se puede usar texture_image_url o texture_prompt para guiar el proceso de texturizado, no ambos. Si se proporcionan ambos parámetros, entonces texture_prompt se usará de forma predeterminada para texturizar el modelo. El texturizado, ya sea por texto o por imagen, costará 10 créditos por tarea.
Name
should_remesh
Type
boolean
predeterminado false (Meshy 6 and Meshy 7 models), true (others)
Description
Controla si se habilita la fase de remallado. Para obtener el modelo de mayor calidad, recomendamos establecer should_remesh en false.
Solo aplica cuando should_remesh = true
Name
topology
Type
string
predeterminado triangle
Description
Especifique la topology del modelo generado.
Valores disponibles:
quad: Genera una malla predominantemente de cuadriláteros.
triangle: Genera una malla de triángulos decimada.
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
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.
Name
target_polycount
Type
integer
Description
Número objetivo de polígonos (caras) en la salida. El recuento real puede desviarse del objetivo dependiendo de la geometría.
target_polycount tiene efecto en dos casos independientes:
Remallado: con should_remesh: true en un modelo standard. La malla se remalla (decima) hasta aproximadamente este recuento. Rango de 100 a 300,000, predeterminado 30,000. Si se establece decimation_mode, este tiene prioridad y se ignora target_polycount.
Smart Topology: con model_type: smart-topology y ai_model: meshy-t2. El modelo se genera directamente con este recuento de caras; no se ejecuta ningún remallado y no se requiere should_remesh. Rango de 100 a 15,000, predeterminado 4,000.
Name
symmetry_mode
Type
string
⚠ obsoleto
predeterminado auto
Description
Obsoleto. Este parámetro ya no afecta 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 según la geometría de entrada.
on: Fuerza la simetría durante la generación.
Name
pose_mode
Type
string
predeterminado ""
Description
Especifique el modo de pose 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
Use 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ézcalo en false para preservar la apariencia exacta de la imagen de entrada sin ningún procesamiento de estilo.
Solo se admite cuando ai_model es meshy-6, meshy-7.1 o latest.
Name
remove_lighting
Type
boolean
predeterminado true
Description
Elimina los reflejos y las 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.
Name
moderation
Type
boolean
predeterminado false
Description
Cuando se establece en true, el contenido de entrada se evaluará automáticamente para detectar contenido potencialmente dañino. Si se detecta contenido dañino, la tarea no continuará con la generación.
Se evaluará 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 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 por IA para estimar automáticamente la altura del objeto en el mundo real y redimensionar el modelo en consecuencia. El origen será bottom de forma predeterminada, a menos que origin_at se establezca explícitamente.
Name
alpha_thumbnail
Type
boolean
predeterminado false
Description
Cuando se establece en true, la tarea además renderiza 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.
Name
multi_view_thumbnails
Type
boolean
predeterminado false
Description
Cuando se establece en true, la tarea además renderiza cuatro miniaturas de vistas cardinales (frontal, derecha, posterior, izquierda) y las devuelve en thumbnail_urls en la respuesta GET. El campo thumbnail_url existente 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 de la tarea de Imagen a 3D recién creada.
Modos de fallo
Name
400 - Bad Request
Description
La solicitud fue inaceptable. Causas comunes:
Falta un parámetro: se debe proporcionar image_url o input_task_id.
Tarea de entrada no válida: input_task_id debe hacer referencia a una tarea SUCCEEDED de Texto a imagen o Imagen a imagen que produzca exactamente una imagen.
Formato de imagen no válido: el image_url proporcionado no tiene un formato admitido (.jpg, .jpeg, .png).
URL inaccesible: no se pudo descargar 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.
Modelo no compatible para low poly: ai_model: "meshy-6-lite" no admite model_type: "lowpoly".
Modelo no compatible para Ultra: geometry_resolution requiere meshy-7.1 o latest.
Name
401 - Unauthorized
Description
Error de autenticación. Verifique su clave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para realizar esta tarea.
Name
429 - Too Many Requests
Description
Ha superado su límite de tasa.
Request
POST
/openapi/v1/image-to-3d
# Simple request with required paramscurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-XPOST \-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 Ultra 4K geometry, remesh, PBR, and A-posecurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>", "ai_model": "meshy-7.1", "geometry_resolution": "4k", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Este endpoint le permite recuperar una tarea de Imagen a 3D dado un id de tarea válido.
Consulte El objeto de tarea de Imagen a 3D para ver qué
propiedades se incluyen en 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 desea recuperar.
Este endpoint elimina permanentemente una tarea de Imagen a 3D, 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 Imagen a 3D que se va a eliminar.
Estado de la tarea
Una tarea que aún está PENDING se elimina y se reembolsan los
créditos consumidos en el momento de la creación.
Una tarea que ya está IN_PROGRESS no se puede eliminar: la solicitud se
rechaza con 409 Conflict y la tarea sigue ejecutándose. Los créditos de una tarea
que el worker ya ha iniciado no son reembolsables, por lo que eliminarla a mitad de
ejecución te costaría tanto los créditos como el resultado. Espera a que alcance
SUCCEEDED, FAILED o CANCELED, y luego elimínala.
Una tarea en un estado terminal (SUCCEEDED, FAILED o CANCELED) se elimina
sin reembolso.
Devuelve
Devuelve 200 OK en caso de éxito, o 409 Conflict cuando la tarea está
IN_PROGRESS.
// 200 OK on success, with an empty body.//// 409 Conflict when the task is IN_PROGRESS — the task is left running:{"message":"Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."}
El objeto Task de Imagen a 3D es una unidad de trabajo que Meshy monitorea 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 k-sortable 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 al archivo del modelo 3D texturizado 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 al archivo GLB.
Name
fbx
Type
string
Description
URL descargable al archivo FBX.
Name
obj
Type
string
Description
URL descargable al archivo OBJ.
Name
usdz
Type
string
Description
URL descargable al archivo USDZ.
Name
mtl
Type
string
Description
URL descargable al archivo MTL, devuelto junto con las exportaciones OBJ cuando hay texturas presentes.
Name
stl
Type
string
Description
URL descargable al archivo STL.
Name
3mf
Type
string
Description
URL descargable al archivo 3MF. Solo está presente cuando se solicitó 3mf a través de target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL descargable al archivo GLB original antes del remesh.
Disponible solo cuando la tarea se creó con should_remesh: true y save_pre_remeshed_model: true a la vez.
Name
thumbnail_url
Type
string
Description
URL descargable a la imagen de miniatura del archivo del 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 a 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; en caso 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 múltiples ángulos en flujos por lotes sin descargar el GLB.
Solo está presente cuando la tarea se creó con multi_view_thumbnails: true y ha alcanzado el estado SUCCEEDED. Las tareas antiguas y las tareas creadas sin esta opció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 trasera, 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 a la imagen de textura que se usó para guiar el proceso de texturizado.
Name
ultra_mode
Type
boolean
⚠ obsoleto
Description
Obsoleto; en su lugar, lee geometry_resolution.
Name
geometry_resolution
Type
string
Description
El nivel Ultra en el que se ejecutó la tarea (2k o 4k); se omite para standard.
Name
progress
Type
integer
Description
Progress de la tarea. Si la tarea aún no se ha iniciado, esta propiedad será 0. Una vez que la tarea haya tenido éxito, esta será 100.
Name
started_at
Type
timestamp
Description
Marca de tiempo de cuándo se inició la tarea, en milisegundos. Si la tarea aún no se ha iniciado, 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, el viernes 1 de septiembre de 2023 a las 12:00:00 PM GMT se representa como 1693569600000. Esto aplica
a todas las marcas de tiempo en Meshy API.
Name
created_at
Type
timestamp
Description
Marca de tiempo de cuándo se creó la tarea, en milisegundos.
Name
expires_at
Type
timestamp
Description
Marca de tiempo de cuándo expira el resultado de la tarea, en milisegundos.
Name
finished_at
Type
timestamp
Description
Marca de tiempo de cuándo 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 a la imagen del mapa de color base.
Name
metallic
Type
string
Description
URL descargable a la imagen del mapa metálico.
Si la tarea se crea con enable_pbr: false, esta propiedad se omitirá.
Name
normal
Type
string
Description
URL descargable a la imagen del mapa de normales.
Si la tarea se crea con enable_pbr: false, esta propiedad se omitirá.
Name
roughness
Type
string
Description
URL descargable a la imagen del mapa de rugosidad.
Si la tarea se crea con enable_pbr: false, esta propiedad se omitirá.
Name
emission
Type
string
Description
URL descargable a la imagen del mapa de emisión.
Si la tarea se crea con enable_pbr: false, o ai_model es meshy-6-lite, meshy-7.1, o latest, esta propiedad se omitirá.
Name
preceding_tasks
Type
integer
Description
El número 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 las tareas fallidas. Consulta Errores para 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 las tareas FAILED (los créditos se reembolsan en caso de fallo).