API de lámpara de Creative Lab

La foto en la que se basará la pantalla de lámpara, como una URL pública o un data URI (data:image/jpeg;base64,<tus datos de imagen codificados en base64>).

La imagen debe ser un archivo JPG, JPEG, PNG o WebP de máximo 20 MB.

El tipo de sujeto en la foto, que determina cómo Meshy lo estiliza.

Valores disponibles:

• character: un solo personaje u objeto, como una figura, un animal o una mascota
• landscape: una escena exterior o panorama, como una montaña, un paisaje urbano o un bosque

Un nombre para la tarea, de hasta 100 caracteres. Se devuelve en el campo name de la tarea. Un nombre más largo devuelve 400.

Si se debe eliminar el fondo de la imagen del prototipo. true devuelve un PNG RGBA transparente, para que puedas colocar el sujeto sobre cualquier fondo. Meshy también construye el modelo 3D a partir de la imagen sin su fondo. Si Meshy no puede eliminar el fondo, usa la imagen con su fondo, y la tarea aún se completa con éxito.

La solicitud no puede ejecutarse. Por ejemplo:

• Falta image_url.
• La imagen no es un archivo JPG, JPEG, PNG o WebP.
• La imagen es demasiado pequeña, supera los 20 MB, o supera el número máximo de píxeles.
• Meshy no puede descargar la imagen, por ejemplo porque la URL devuelve 404 o agota el tiempo de espera.
• El data URI no es base64 válido.
• La imagen fue marcada como NSFW.
• image_subject no es character ni landscape.

El mensaje de error indica qué problema encontró. Corrige la solicitud y envíala de nuevo.

La clave de API falta o no es válida. Revisa el encabezado Authorization.

Se aplica uno de estos casos:

• La cuenta no tiene suficientes créditos.
• La clave de API, el espacio de trabajo o el miembro alcanzó su límite de créditos.
• La cuenta está en el plan gratuito.

Revisa tus créditos y plan, luego reintenta.

Tu equipo tiene IP Filtering activado, y Meshy marcó la imagen por propiedad intelectual de terceros. Envía una imagen que tengas derecho a usar.

Se alcanzó uno de estos límites:

• Enviaste más solicitudes de las que permite tu límite de tasa. Espera unos segundos y vuelve a intentarlo. Consulta Límites de tasa.
• Demasiadas de tus tareas están en cola o en ejecución. Espera a que terminen algunas, luego reintenta.
• En un plan ilimitado sin créditos restantes, alcanzaste el número de tareas que pueden ejecutarse sin créditos. Espera a que termine una tarea, o añade créditos.

Meshy encontró un error del servidor, por ejemplo porque no pudo ejecutar la verificación de propiedad intelectual en la imagen. Meshy no crea la tarea y reembolsa cualquier crédito que haya cobrado. Reintenta la solicitud.

El ID de la tarea de prototipo a construir. Debe ser una tarea creada por tu cuenta con POST /openapi/creative-lab/lamp/v1/prototype, con el estado SUCCEEDED.

Un ID que no corresponda a una de tus tareas de prototipo de lámpara de la API devuelve 404, incluyendo un prototipo creado en la aplicación web.

Un nombre para la tarea, de hasta 100 caracteres. Se devuelve en el campo name de la tarea. Un nombre más largo devuelve 400.

El tamaño de la dimensión más grande de la pantalla de la lámpara, en milímetros, de 50 a 400. Meshy escala el modelo de forma uniforme para que encaje. 0 usa el valor predeterminado, y cualquier otro valor fuera del rango devuelve 400.

El grosor de pared de la pantalla de la lámpara, en milímetros, de hasta 10. 0 usa el valor predeterminado, y un valor negativo o uno superior a 10 devuelve 400.

El porcentaje de la altura del modelo que se corta de forma plana en la parte inferior, de 1 a 100. La base plana permite que la pantalla de la lámpara se asiente en la cama de impresión y deja espacio para la fijación. Un valor fuera del rango devuelve 400.

El preajuste de fijación de luz, que determina cómo Meshy construye la parte inferior.

Valores disponibles:

• bambu_mh001_60mm: una pantalla de lámpara con fondo abierto y una placa base con un orificio de fijación de 60 mm, ambos en model_urls.lamp_stl, y el soporte de fijación en model_urls.base_stl
• none: una única pantalla de lámpara sellada en model_urls.lamp_stl, sin model_urls.base_stl

Cuánto mover el orificio de fijación a lo largo del eje X desde el centro de la pantalla de la lámpara, en milímetros, de -80 a 80. Se aplica solo cuando light_source_preset no es none.

Cuánto mover el orificio de fijación a lo largo del eje Z (profundidad) desde el centro de la pantalla de la lámpara, en milímetros, de -80 a 80. Se aplica solo cuando light_source_preset no es none.

La rotación alrededor del eje X que se aplica al modelo antes de que Meshy lo procese, en grados, de -360 a 360. Meshy aplica las tres rotaciones como ángulos de Euler XYZ alrededor del centro del modelo.

La rotación alrededor del eje Y que se aplica al modelo antes de que Meshy lo procese, en grados, de -360 a 360.

La rotación alrededor del eje Z que se aplica al modelo antes de que Meshy lo procese, en grados, de -360 a 360.

Si se debe agregar un archivo result.json al paquete zip, con el nombre del pipeline que se ejecutó, advertencias y rutas de archivo. Requiere que output.format esté configurado como zip. true con stl devuelve 400.

Los archivos que devuelve la construcción.

Valores disponibles:

• stl: model_urls.lamp_stl, la pantalla de la lámpara con su placa base cuando hay un preajuste de fijación, y model_urls.base_stl cuando light_source_preset no es none
• zip: un archivo zip en model_urls.bundle_zip, con lamp.stl, y base.stl y result.json cuando corresponda

La solicitud no se puede ejecutar. Por ejemplo:

• input_task_id falta o no es un ID de tarea válido.
• El estado de la tarea de prototipo no es SUCCEEDED. Si aún se está ejecutando, espera y vuelve a intentarlo. Si falló o fue cancelada, crea una nueva tarea de prototipo.
• La tarea de prototipo tuvo éxito pero no tiene un modelo 3D. Crea una nueva tarea de prototipo.
• Un campo de options está fuera de su rango o no es un valor disponible.
• output.format no es stl ni zip, o include_result_json es true sin zip.

El mensaje de error indica qué problema encontró.

Falta la clave de API o no es válida. Verifica el encabezado Authorization.

Se aplica uno de estos casos:

• La cuenta no tiene suficientes créditos.
• La clave de API, el espacio de trabajo o el miembro alcanzó su límite de créditos.
• La cuenta está en el plan gratuito.

Verifica tus créditos y plan, luego vuelve a intentarlo.

input_task_id no coincide con ninguna tarea de prototipo de lámpara que tu cuenta haya creado con la API. Un prototipo creado en la aplicación web también devuelve 404. Envía el ID de result de una respuesta de creación de prototipo.

Se alcanzó uno de estos límites:

• Enviaste más solicitudes de las que permite tu límite de tasa. Espera unos segundos y vuelve a intentarlo. Consulta Límites de tasa.
• Hay demasiadas tareas tuyas en cola o en ejecución. Espera a que algunas terminen y vuelve a intentarlo.
• En un plan ilimitado sin créditos restantes, alcanzaste el número de tareas que pueden ejecutarse sin créditos. Espera a que termine una tarea, o agrega créditos.

El ID de la tarea proveniente de la respuesta de creación.

id no es un ID de tarea válido. Envía el ID result de la respuesta de creación.

Tu equipo tiene activado el Filtrado de IP, y Meshy marcó la imagen de la tarea de prototipo por propiedad intelectual de terceros. Las tareas de build y los equipos en el plan Enterprise no reciben este error. Crea una tarea de prototipo a partir de una imagen que tengas derecho a usar.

Ninguna tarea de Lamp con este ID pertenece a tu cuenta, o la etapa de la tarea no coincide con la ruta. Revisa el ID y usa /prototype o /build según corresponda a la tarea.

Meshy no pudo ejecutar la verificación de propiedad intelectual. Vuelve a intentar la solicitud.

El ID de la tarea a cancelar.

Se aplica uno de estos casos:

• id no es un ID de tarea válido. Envía el ID result de la respuesta de creación.
• La tarea ya tiene un estado final (SUCCEEDED, FAILED o CANCELED), por lo que no se puede cancelar.

Ninguna tarea de lámpara con este ID pertenece a tu cuenta, o la etapa de la tarea no coincide con la ruta. Verifica el ID y usa /prototype o /build para que coincida con la tarea.

El ID de la tarea de la respuesta de creación.

La etapa a listar, prototype o build.

La página a devolver, de 1 a 255. 0 devuelve la primera página. Un valor fuera de 0 a 255 devuelve 400.

Número de tareas por página, hasta 100. Un valor de 101 a 255 devuelve 100 tareas, y 0 usa el valor predeterminado. Un valor fuera de 0 a 255 devuelve 400.

El orden de clasificación.

Valores disponibles:

• -created_at: más recientes primero
• +created_at: más antiguos primero

El ID de la tarea. No dependas de su formato.

El tipo de tarea, siempre creative-lab-lamp-prototype.

El name que enviaste al crear la tarea, o "" si no enviaste ninguno.

El estado de la tarea.

Valores disponibles:

• PENDING: esperando en la cola
• IN_PROGRESS: generando el resultado
• SUCCEEDED: final, con el resultado
• FAILED: final, con el motivo en task_error
• CANCELED: final, sin resultado

Porcentaje del trabajo completado, de 0 a 100. Es 0 hasta que la tarea comienza y 100 cuando tiene éxito.

Momento en que se creó la tarea, en milisegundos Unix.

Momento en que un worker comenzó la tarea, en milisegundos Unix. null hasta entonces.

Momento en que la tarea alcanzó un estado final, en milisegundos Unix. null hasta entonces.

Momento en que el resultado de la tarea expira, en milisegundos Unix. Son 3 días después de finished_at, o 3 días después de created_at hasta que la tarea termina. Para cuentas Enterprise, que conservan los resultados de la API indefinidamente, es unos 100 años después. Consulta Retención de recursos.

La posición de la tarea en la cola mientras está PENDING. 1 significa que comienza a continuación. 0 después de que la tarea sale de la cola, y siempre 0 en los resultados de listas.

Por qué falló la tarea. null a menos que status sea FAILED. Consulta Errores.

Número de créditos cobrados por la tarea, después de cualquier reembolso. Una solicitud que devuelve un error no se cobra. Una tarea fallida es 0, porque Meshy la reembolsa. Cancelar reembolsa una tarea solo mientras está PENDING. Si Meshy no puede leer el cobro, una respuesta de obtención o de transmisión omite el campo, y una solicitud de lista devuelve 500. En ese caso, reintenta la solicitud.

URLs de descarga para el modelo 3D generado a partir de la imagen conceptual. {} hasta que la tarea tiene éxito.

URL de descarga para una imagen de vista previa del modelo 3D. "" hasta que la tarea tiene éxito.

URLs de descarga para la imagen conceptual. El array tiene una URL después de que la tarea tiene éxito, y está vacío hasta entonces.

El ID de la tarea. No dependas de su formato.

El tipo de tarea, siempre creative-lab-lamp-build.

El name que enviaste al crear la tarea, o "" si no enviaste ninguno.

El estado de la tarea.

Valores disponibles:

• PENDING: esperando en la cola
• IN_PROGRESS: generando el resultado
• SUCCEEDED: final, con el resultado
• FAILED: final, con el motivo en task_error
• CANCELED: final, sin resultado

Porcentaje del trabajo completado, de 0 a 100. Es 0 hasta que la tarea comienza y 100 cuando tiene éxito.

Hora en que se creó la tarea, en milisegundos Unix.

Hora en que un trabajador inició la tarea, en milisegundos Unix. null hasta entonces.

Hora en que la tarea alcanzó un estado final, en milisegundos Unix. null hasta entonces.

Hora en que expira el resultado de la tarea, en milisegundos Unix. Son 3 días después de finished_at, o 3 días después de created_at hasta que la tarea finaliza. Para las cuentas Enterprise, que conservan los resultados de la API de forma indefinida, es unos 100 años después. Consulta Retención de recursos.

La posición de la tarea en la cola mientras está en PENDING. 1 significa que comienza a continuación. 0 después de que la tarea sale de la cola, y siempre 0 en resultados de lista.

Por qué falló la tarea. null a menos que status sea FAILED. Consulta Errores.

Número de créditos cobrados por la tarea, después de cualquier reembolso. Una solicitud que devuelve un error no se cobra. Una tarea fallida es 0, porque Meshy la reembolsa. Cancelar reembolsa una tarea solo mientras está en PENDING. Si Meshy no puede leer el cargo, una respuesta de obtención o de flujo omite el campo, y una solicitud de lista devuelve 500. En ese caso, reintenta la solicitud.

URLs de descarga para los archivos imprimibles. Qué claves aparecen depende de output.format y options.light_source_preset.