Convierte un prompt de texto o una foto de origen en una pantalla de lámpara imprimible en 3D en dos etapas: prototipo genera una imagen conceptual estilizada en blanco mate, luego construcción convierte esa imagen conceptual en una pantalla de lámpara STL hueca (opcionalmente emparejada con un disco base para un accesorio de fuente de luz). Las dos etapas están vinculadas a través de input_task_id.
Genera una única imagen conceptual en blanco mate para la pantalla de la lámpara, ya sea a partir de un prompt de texto (texto-a-3D) o de una foto de referencia (imagen-a-3D). El ID de tarea devuelto es lo que pasas como input_task_id al endpoint de construcción. Consulta
El Objeto de Tarea de Prototipo de Lámpara
para la forma de la respuesta.
Parámetros
Exactamente uno de text o image_url es requerido. Pasar ambos, o ninguno, devuelve 400.
Name
text
Type
string
Requerido
Description
Prompt de texto que describe el tema deseado para la pantalla de la lámpara. Requerido cuando se omite image_url. Máximo 800 caracteres.
Name
image_url
Type
string
Requerido
Description
Foto fuente que Meshy utiliza como referencia visual para la pantalla de la lámpara. Requerido cuando se omite text. Actualmente soportamos los formatos .jpg, .jpeg, .png, y .webp.
Hay dos maneras 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
image_subject
Type
string
predeterminado character
Description
Pista de categoría de sujeto para la ruta de imagen-a-3D. Valores disponibles:
character (por defecto) — sujeto de un solo personaje / objeto (figura, animal, mascota, etc.).
landscape — sujeto de escena al aire libre / panorama (montaña, paisaje urbano, bosque, etc.).
Ignorado en la ruta de texto-a-3D.
Name
name
Type
string
Description
Nombre de tarea opcional para propósitos de visualización. Máximo 100 caracteres.
Name
remove_background
Type
boolean
predeterminado false
Description
Cuando se establece en true, la imagen del prototipo se devuelve como un PNG RGBA transparente con el fondo eliminado, para que puedas componer el sujeto sobre cualquier fondo.
Devuelve
La propiedad result de la respuesta contiene el id de tarea de la nueva tarea de prototipo de lámpara creada. Consulta el endpoint Obtener una Tarea o suscríbete al stream hasta que la tarea alcance SUCCEEDED, luego pasa ese ID al endpoint de construcción como input_task_id.
Modos de Fallo
Name
400 - Bad Request
Description
La solicitud fue inaceptable. Causas comunes:
Parámetro faltante: Se requiere exactamente uno de text o image_url.
Ambos proporcionados: Pasar tanto text como image_url es rechazado — son mutuamente excluyentes.
Formato de imagen no válido: El image_url proporcionado no es un formato soportado (.jpg, .jpeg, .png, .webp).
Dimensiones de imagen fuera de rango: La imagen es demasiado pequeña, excede el tamaño máximo de archivo, o excede el conteo máximo de píxeles.
URL inalcanzable: El image_url no pudo ser descargado (404 o timeout).
Data URI no válido: La cadena base64 está mal formada.
Contenido marcado: La imagen de entrada fue marcada por moderación NSFW o de propiedad intelectual.
Texto demasiado largo: text excede 800 caracteres.
image_subject no válido: No es uno de character / landscape.
Name
401 - Unauthorized
Description
La autenticación falló. Por favor, verifica 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.
Solicitud
POST
/openapi/creative-lab/lamp/v1/prototype
# Stage 1 (image-to-3D): generate a matte-white lampshade concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype \-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>", "image_subject": "character" }'# Stage 1 (text-to-3D): generate from a text promptcurlhttps://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "text": "a stylized owl perched on a tree branch under moonlight" }'
Respuesta
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Ejemplo de prototipo
Comienza con una foto fuente, luego genera la imagen de prototipo utilizada por la etapa de construcción de la lámpara.
Genera la pantalla de lámpara final imprimible en 3D a partir de una tarea de prototipo exitosa. La construcción ejecuta una canalización de imagen a 3D en la imagen conceptual del prototipo, luego postprocesa la malla a través del procesador de lámparas para ahuecarla, aplanar la parte superior, opcionalmente cortar una base y (cuando se elige un preset de accesorio) emitir un disco base separado para la fuente de luz. Consulta El Objeto de Tarea de Construcción de Lámpara para la forma de la respuesta.
Parámetros
Name
input_task_id
Type
string
Requerido
Description
El ID de la tarea de un prototipo creado a través de este mismo endpoint de OpenAPI. El prototipo debe haber sido creado con la misma clave de API, debe haber alcanzado SUCCEEDED, y debe haber producido exactamente una imagen candidata.
Las tareas de prototipo creadas a través de la aplicación web no son aceptadas — el endpoint de construcción acepta solo tareas de prototipo producidas por POST /openapi/creative-lab/lamp/v1/prototype y rechaza cualquier otra fuente con 404.
Name
name
Type
string
Description
Nombre de tarea opcional para propósitos de visualización. Máximo 100 caracteres.
options
Parámetros de ajuste opcionales para la geometría de la pantalla de lámpara. Cada campo tiene un valor predeterminado razonable — envía solo los que deseas sobrescribir.
Name
diameter_mm
Type
number
predeterminado 80
Description
Dimensión máxima objetivo de la caja delimitadora de la pantalla de lámpara, en milímetros. La malla se escala uniformemente para ajustarse. Rango: [50, 400].
Name
thickness_mm
Type
number
predeterminado 1.5
Description
Grosor de pared de la pantalla de lámpara hueca, en milímetros. Rango: (0, 10].
Name
cut_amount_percent
Type
number
predeterminado 35
Description
Porcentaje de la altura de la pantalla de lámpara a aplanar en la parte superior para que la impresión pueda sentarse en la cama. Rango: [1, 100].
Name
light_source_preset
Type
string
predeterminado bambu_mh001_60mm
Description
Preset de accesorio de fuente de luz que determina si (y qué) disco base emitir junto con la pantalla de lámpara. Valores disponibles:
bambu_mh001_60mm (predeterminado) — emite un disco base de 60 mm dimensionado para un accesorio de fuente de luz compatible. El resultado incluye model_urls.base_stl.
none — sin accesorio, sin disco base. model_urls.base_stl se omite.
Name
fixture_offset_x_mm
Type
number
predeterminado 0
Description
Desplazamiento horizontal en el eje X del recorte del accesorio relativo al centro de la pantalla de lámpara, en milímetros. Solo significativo cuando light_source_preset ≠ none. Rango: [-80, 80].
Name
fixture_offset_z_mm
Type
number
predeterminado 0
Description
Desplazamiento vertical en el eje Z del recorte del accesorio relativo a la parte inferior de la pantalla de lámpara, en milímetros. Rango: [-80, 80].
Name
rotate_x_deg
Type
number
predeterminado 0
Description
Rotación alrededor del eje X aplicada a la malla importada antes del procesamiento, en grados. Rango: [-360, 360].
Name
rotate_y_deg
Type
number
predeterminado 0
Description
Rotación alrededor del eje Y aplicada a la malla importada antes del procesamiento, en grados. Rango: [-360, 360].
Name
rotate_z_deg
Type
number
predeterminado 0
Description
Rotación alrededor del eje Z aplicada a la malla importada antes del procesamiento, en grados. Rango: [-360, 360].
Name
include_result_json
Type
boolean
predeterminado false
Description
Cuando es true y output.format es zip, incluye el result.json del procesador de lámparas (que contiene métricas de malla medidas + el conjunto de opciones resuelto) dentro del paquete. Ignorado cuando output.format es stl.
output
Selector de formato de cable opcional. Predeterminado a stl.
Name
format
Type
string
predeterminado stl
Description
Paquete de artefactos devuelto por la construcción. Valores disponibles:
stl (predeterminado) — devuelve la pantalla de lámpara como model_urls.lamp_stl, más model_urls.base_stl cuando light_source_preset ≠ none.
zip — empaqueta cada artefacto que el procesador emite (lamp.stl, opcional base.stl, opcional result.json) en un solo zip y lo devuelve bajo model_urls.bundle_zip.
Devuelve
La propiedad result de la respuesta contiene el id de la tarea de la nueva tarea de construcción de lámpara creada. Consulta el endpoint Obtener una Tarea o suscríbete al stream hasta que la tarea alcance SUCCEEDED, luego descarga los artefactos de model_urls.
Modos de Fallo
Name
400 - Bad Request
Description
La solicitud no fue aceptable. Causas comunes:
Parámetro faltante: input_task_id es requerido.
UUID inválido: El input_task_id no es un UUID válido.
Padre no exitoso: La tarea de prototipo referenciada no ha alcanzado SUCCEEDED aún.
Sin candidato: La tarea de prototipo tuvo éxito pero no produjo ninguna imagen candidata.
Opciones fuera de rango: Uno de los campos de options cayó fuera de su rango permitido o conjunto de enumeración.
Name
401 - Unauthorized
Description
La autenticación falló. Por favor, verifica tu clave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para realizar esta tarea.
Name
404 - Not Found
Description
La tarea de prototipo referenciada no existe, pertenece a un usuario diferente, o fue creada a través de la aplicación web (solo las tareas de prototipo en modo API se encadenan en la construcción).
Recuperar una tarea de prototipo o construcción dada una id de tarea válida. La ruta de la URL
debe coincidir con la etapa de la tarea: una tarea de construcción obtenida a través de
/prototype/:id devuelve 404, y viceversa.
Cancelar una tarea de lámpara. Si la tarea aún está PENDING, los créditos consumidos
al momento de la creación son reembolsados. Las tareas que ya están IN_PROGRESS se
cancelan sin reembolso (el trabajador puede ya estar consumiendo recursos).
Las tareas que ya han alcanzado un estado terminal (SUCCEEDED, FAILED,
CANCELED) no pueden ser canceladas.
La ruta URL debe coincidir con la etapa de la tarea — DELETE en
/prototype/:buildId devuelve 404.
Parámetros de Ruta
Name
id
Type
path
Description
Identificador único para la tarea de lámpara a cancelar.
Retornos
Devuelve 204 No Content en caso de éxito con un cuerpo vacío.
Modos de Falla
Name
400 - Bad Request
Description
La tarea ya está en un estado terminal y no puede ser cancelada.
Name
404 - Not Found
Description
La tarea no existe, pertenece a un usuario diferente, o su etapa no coincide con la ruta URL.
Transmite actualizaciones en tiempo real para una tarea de lámpara a través de Server-Sent Events (SSE).
La ruta de la URL debe coincidir con la etapa de la tarea — abrir un flujo en
/prototype/:buildId/stream emite un único event: error payload con
status_code: 404 y cierra el flujo.
Parámetros
Name
id
Type
path
Description
Identificador único para la tarea de lámpara a transmitir.
Retornos
Devuelve un flujo de objetos de tarea de Prototipo de Lámpara
o Construcción de Lámpara como
Server-Sent Events. Para tareas PENDING o IN_PROGRESS, el flujo de respuesta
solo incluirá los campos necesarios de progress y status.
// Error event example (wrong stage or task not found)event: errordata: {"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: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","progress": 0,"status": "PENDING"}event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","type": "creative-lab-lamp-build","status": "SUCCEEDED","progress": 100,"created_at": 1729123500000,"started_at": 1729123510000,"finished_at": 1729123535000,"expires_at": 1729382735000,"task_error": null,"consumed_credits": 30,"model_urls": {"lamp_stl":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***","base_stl":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***" }}
Recupera una lista paginada de tus tareas de lámpara para una sola etapa. La ruta
URL selecciona la etapa — /prototype devuelve tareas de prototipo; /build
devuelve tareas de construcción. Las tareas de la otra etapa no se incluyen en ninguna
de las respuestas.
Parámetros de Ruta
Name
stage
Type
path
Requerido
Description
Puede ser prototype o build. La colección devuelve solo tareas
cuya etapa coincide con la URL — al buscar /prototype nunca se devuelven
tareas de construcción y viceversa.
Parámetros de Consulta
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 del tamaño de la página. El máximo permitido es 50 elementos.
Name
sort_by
Type
string
predeterminado -created_at
Description
Campo para ordenar. Valores disponibles:
+created_at: Ordenar por tiempo de creación en orden ascendente.
-created_at: Ordenar por tiempo de creación en orden descendente.
El objeto de tarea del prototipo de lámpara es una unidad de trabajo que Meshy sigue para generar una imagen conceptual estilizada en blanco mate a partir de un prompt de texto o una foto de origen. La salida de esta etapa se encadena en la etapa de construcción a través de input_task_id.
Propiedades
Name
id
Type
string
Description
Identificador único para la tarea. Aunque usamos un UUID ordenable por k para los ids 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. El valor es creative-lab-lamp-prototype.
Name
name
Type
string
Description
El nombre de la tarea proporcionado cuando se creó la tarea. Cadena vacía si no se proporcionó un nombre.
Name
status
Type
string
Description
Estado de la tarea. Los valores posibles son uno de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
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 haya tenido éxito, esto se convertirá en 100.
Name
created_at
Type
timestamp
Description
Marca de tiempo de cuándo se creó la tarea, en milisegundos.
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 se aplica a todas las marcas de tiempo en Meshy API.
Name
started_at
Type
timestamp
Description
Marca de tiempo de cuándo 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 cuándo se terminó la tarea, en milisegundos. Si la tarea aún no ha terminado, esta propiedad será 0.
Name
expires_at
Type
timestamp
Description
Marca de tiempo de cuándo expira el resultado de la tarea, en milisegundos.
Name
preceding_tasks
Type
integer
Description
El conteo de tareas precedentes.
El valor de este campo es significativo solo si el estado de la tarea es PENDING.
Name
task_error
Type
object
Description
Detalles del error para 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 tareas FAILED (los créditos se reembolsan en caso de fallo).
Name
image_urls
Type
array of strings
Description
URLs descargables para los candidatos de imagen conceptual generados por esta tarea de prototipo. Actualmente, la API siempre devuelve exactamente un candidato; el campo es un arreglo para que futuras revisiones puedan mostrar múltiples candidatos sin un cambio disruptivo.
El objeto de Tarea de Construcción de la Lámpara es una unidad de trabajo que Meshy rastrea para generar la pantalla de lámpara imprimible en 3D final a partir de una tarea de prototipo exitosa. La construcción ejecuta un borrador de imagen a 3D + pipeline de textura en la imagen conceptual del prototipo, luego postprocesa la malla a través del procesador de lámparas para ahuecar, aplanar y (opcionalmente) cortar una base de accesorio.
Propiedades
Name
id
Type
string
Description
Identificador único para la tarea.
Name
type
Type
string
Description
Tipo de la tarea. El valor es creative-lab-lamp-build.
Name
name
Type
string
Description
El nombre de la tarea proporcionado cuando se creó la tarea. Cadena vacía si no se proporcionó un nombre.
Name
status
Type
string
Description
Estado de la tarea. Los valores posibles son uno de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
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 haya tenido éxito, esto se convertirá en 100.
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.
Name
finished_at
Type
timestamp
Description
Marca de tiempo de cuando se terminó la tarea, en milisegundos.
Name
expires_at
Type
timestamp
Description
Marca de tiempo de cuando expira el resultado de la tarea, en milisegundos.
Name
preceding_tasks
Type
integer
Description
El conteo de tareas precedentes. Significativo solo cuando el estado es PENDING.
Name
task_error
Type
object
Description
Detalles del error para tareas fallidas. Consulte 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. Devuelve 0 para tareas FAILED (los créditos se reembolsan en caso de fallo).
Name
model_urls
Type
object
Description
URLs descargables para los artefactos generados, claveados por nombre de artefacto. El conjunto de claves depende de output.format y options.light_source_preset:
Name
lamp_stl
Type
string
Description
URL descargable para la pantalla de lámpara lamp.stl. Presente cuando output.format era stl (el predeterminado).
Name
base_stl
Type
string
Description
URL descargable para la base del accesorio base.stl. Presente cuando output.format era stlyoptions.light_source_preset no era none. Omitido cuando el preajuste del accesorio era none.
Name
bundle_zip
Type
string
Description
URL descargable para un paquete zip de cada artefacto que el procesador emite (lamp.stl, base.stl opcional, y — cuando options.include_result_json es true — result.json). Presente cuando output.format era zip. Cuando bundle_zip está presente, lamp_stl / base_stl se omiten.
Ejemplo de Objeto de Tarea de Construcción de Lámpara