API de imán de nevera de Creative Lab

Convierte una foto en un imán de nevera imprimible en 3D con un relieve coloreado y una parte trasera plana, en dos etapas. Una tarea de prototipo genera una imagen conceptual coloreada a partir de la foto. Una tarea de construcción convierte esa imagen en un modelo 3D en relieve, y toma el ID de la tarea de prototipo como input_task_id.

POST /openapi/creative-lab/fridge-magnet/v1/prototype
POST /openapi/creative-lab/fridge-magnet/v1/build

POST/openapi/creative-lab/fridge-magnet/v1/prototype

Crear una tarea de prototipo de imán de nevera

Genera una imagen conceptual coloreada a partir de una foto. Para construir el modelo 3D, pasa el ID de esta tarea al endpoint de construcción como input_task_id. Para conocer los campos de la tarea, consulta El objeto de tarea de prototipo de imán de nevera.

Request

POST

/openapi/creative-lab/fridge-magnet/v1/prototype

# Stage 1: generate a colorized fridge magnet concept image
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype \
  -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>"
  }'

Response

{
  "result": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"
}

Prototype example

Start with a source photo, then generate the prototype image used by the fridge magnet build stage.

Source landscape photo used as the Creative Lab Fridge Magnet input — Prototype input

Creative Lab Fridge Magnet prototype output generated from the source photo — Prototype output

Parámetros

Name
image_url
Type
string
Requerido
Description
La foto que se convertirá en una imagen conceptual de imán de nevera, 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.
Name
name
Type
string
Description
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.
Name
remove_background
Type
boolean
predeterminado false
Description
Si se debe eliminar el fondo de la imagen del prototipo. true devuelve un PNG RGBA transparente que conserva todo el imán, para que puedas colocarlo sobre cualquier fondo. La construcción también parte de la imagen sin su fondo. Si Meshy no puede eliminar el fondo, devuelve la imagen con su fondo, y la tarea igualmente se completa con éxito.
La opción remove_background de la construcción es independiente.

Devuelve

El campo result contiene el ID de la nueva tarea de prototipo. Obtén la tarea o transmítela hasta que status sea SUCCEEDED. Luego pasa el ID al endpoint de construcción como input_task_id.

Modos de fallo

Name
400 - Bad Request
Description
La solicitud no se puede ejecutar. 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 excede el número máximo de píxeles.
- Meshy no puede descargar la imagen, por ejemplo porque la URL devuelve 404 o se agota el tiempo de espera.
- El Data URI no es base64 válido.
- La imagen fue marcada como NSFW.
El mensaje de error indica qué problema se encontró. Corrige la solicitud y envíala de nuevo.
Name
401 - Unauthorized
Description
Falta la clave de API o no es válida. Revisa el encabezado Authorization.
Name
402 - Payment Required
Description
Se aplica una de las siguientes situaciones:
- 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 tu plan, luego vuelve a intentarlo.
Name
403 - Forbidden
Description
Tu equipo tiene activado el Filtrado de IP, y Meshy marcó la imagen por propiedad intelectual de terceros. Envía una imagen sobre la que tengas los derechos de uso.
Name
429 - Too Many Requests
Description
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 algunas finalicen y vuelve a intentarlo.
- En un plan ilimitado sin créditos restantes, alcanzaste la cantidad de tareas que pueden ejecutarse sin créditos. Espera a que termine una tarea o agrega créditos.
Name
500 - Internal Server Error
Description
Meshy encontró un error de 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 cobrado. Vuelve a intentar la solicitud.

POST/openapi/creative-lab/fridge-magnet/v1/build

Crear una tarea de construcción de imán de nevera

Genera el imán de nevera listo para impresión 3D a partir de una tarea de prototipo exitosa. Meshy convierte la imagen conceptual del prototipo en un relieve de mapa de profundidad, y devuelve un archivo de modelo en el formato que elijas. Para conocer los campos de la tarea, consulta El objeto de tarea de construcción de imán de nevera.

Request

POST

/openapi/creative-lab/fridge-magnet/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "options": {
      "badge_shape": "rounded-rect",
      "size_mm": 60,
      "relief_height_mm": 3.3
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
}

Build example

The build task turns the selected prototype image into a 3D-printable fridge magnet model.

Creative Lab Fridge Magnet build model preview — Build model preview

Parámetros

Name
input_task_id
Type
string
Requerido
Description
El ID de la tarea de prototipo a construir. Debe ser una tarea creada por tu cuenta con POST /openapi/creative-lab/fridge-magnet/v1/prototype, con estado SUCCEEDED.
Un ID que no corresponda a una de tus tareas de prototipo de imán de nevera creadas desde la API devuelve 404, incluyendo un prototipo creado en la aplicación web.
Name
name
Type
string
Description
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.

`options`

Configuraciones opcionales para la forma del relieve. Cada campo tiene un valor predeterminado, así que envía solo los que quieras cambiar. Un valor fuera del rango de un campo devuelve 400.

Name
badge_shape
Type
string
predeterminado rounded-rect
Description
El contorno del imán cuando Meshy no lo rastrea a partir del sujeto. Meshy lo usa cuando remove_background es false, o cuando no puede encontrar el contorno del sujeto.
Valores disponibles:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
predeterminado 60
Description
La longitud del lado del cuadrado delimitador del imán, en milímetros, hasta 400. 0 usa el valor predeterminado.
Name
relief_height_mm
Type
number
predeterminado 3.3
Description
La altura máxima del relieve por encima de la base, en milímetros, de 0 a 20.
Name
relief_offset_mm
Type
number
predeterminado 0
Description
Cuánto bajar el relieve, en milímetros, de 0 a 20. Meshy lo resta de la altura del relieve en todas partes, hasta la base.
Name
base_thickness_mm
Type
number
predeterminado 2.0
Description
El grosor de la placa base plana detrás del relieve, en milímetros, de 0 a 20. La base predeterminada de 2 mm le da al imán suficiente cuerpo para sujetarse a la nevera, de modo que el relieve no se sienta frágil.
Name
has_closed_back
Type
boolean
predeterminado true
Description
Si se debe cerrar la parte trasera del imán, el lado donde pegas el imán. false deja la parte trasera abierta, como una cáscara.
Name
relief_curve
Type
string
predeterminado linear
Description
La curva que asigna los valores del mapa de profundidad a la altura del relieve.
Valores disponibles:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
predeterminado 1.0
Description
La intensidad de la curva, hasta 10. Las curvas gamma y s-curve lo usan, y linear lo ignora. 0 usa el valor predeterminado.
Name
invert_depth
Type
boolean
predeterminado false
Description
Si se debe invertir el mapa de profundidad, de modo que las áreas más oscuras se conviertan en un relieve más alto.
Name
smoothing
Type
number
predeterminado 0.24
Description
Cuánto suavizar el mapa de profundidad antes de que Meshy construya el relieve, de 0 a 10.
Name
relief_scale
Type
number
predeterminado 1.0
Description
Cuánto ampliar el relieve y su textura dentro del contorno, respecto al centro, hasta 10. Un valor mayor que 1 agranda al sujeto, y un valor menor que 1 lo reduce. No cambia la altura del relieve. 0 usa el valor predeterminado.
Name
depth_threshold
Type
number
predeterminado 0.1
Description
El valor del mapa de profundidad por debajo del cual Meshy establece la profundidad en cero, de 0 a 1.
Name
remove_background
Type
boolean
predeterminado true
Description
Si se debe rastrear el contorno del imán a partir del sujeto, de modo que el imán siga la forma del sujeto. false usa en su lugar el contorno de badge_shape. Meshy también usa badge_shape cuando no puede encontrar el contorno del sujeto.
Esto es independiente del parámetro remove_background del prototipo, que establece si la imagen del prototipo tiene un fondo transparente.
Name
export_resolution
Type
integer
predeterminado 512
Description
La resolución de malla del modelo exportado, de 64 a 512. Meshy construye la geometría a partir de un mapa de profundidad de 512 píxeles, así que una malla más fina añadiría caras sin añadir detalle. 0 usa el valor predeterminado.

`output`

Opcional. Establece el formato de archivo que devuelve la construcción.

Name
format
Type
string
predeterminado glb
Description
El formato de archivo que devuelve la construcción.
Valores disponibles:
- glb: un archivo model.glb, en model_urls.glb
- obj: un archivo zip con model.obj, model.mtl y texture.png, en model_urls.obj
- zip: un archivo zip con todos los archivos que genera Meshy, en model_urls.bundle_zip

Devuelve

El campo result contiene el ID de la nueva tarea de construcción. Obtén la tarea o transmítela en streaming hasta que status sea SUCCEEDED. Luego descarga el archivo desde la única entrada en model_urls.

Modos de fallo

Name
400 - Bad Request
Description
La solicitud no puede ejecutarse. 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 todavía 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 imagen. Crea una nueva tarea de prototipo.
- Un campo de options está fuera de su rango o no es un valor disponible.
El mensaje de error indica qué problema encontró.
Name
401 - Unauthorized
Description
Falta la clave de API o no es válida. Verifica el encabezado Authorization.
Name
402 - Payment Required
Description
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 tu plan, luego vuelve a intentarlo.
Name
404 - Not Found
Description
input_task_id no coincide con ninguna tarea de prototipo de imán de nevera creada por tu cuenta con la API. Un prototipo creado en la aplicación web también devuelve 404. Envía el ID result de una respuesta de creación de prototipo.
Name
429 - Too Many Requests
Description
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 de tus tareas en cola o en ejecución. Espera a que algunas terminen, luego 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 añade créditos.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Obtener una tarea de imán de nevera

Devuelve una tarea de prototipo o de build. La ruta debe coincidir con la etapa de la tarea. Una tarea de build solicitada a través de /prototype/:id devuelve 404, y lo mismo ocurre con una tarea de prototipo solicitada a través de /build/:id.

Para conocer los campos, consulta El objeto de tarea de prototipo de imán de nevera y El objeto de tarea de build de imán de nevera.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Parámetros

Name
id
Type
path
Description
El ID de la tarea proveniente de la respuesta de creación.

Devuelve

El objeto de tarea de prototipo o el objeto de tarea de build, según la etapa indicada en la ruta.

Modos de fallo

Name
400 - Bad Request
Description
id no es un ID de tarea válido. Envía el ID result de la respuesta de creación.
Name
403 - Forbidden
Description
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 con el plan Enterprise no reciben este error. Crea una tarea de prototipo a partir de una imagen sobre la que tengas los derechos de uso.
Name
404 - Not Found
Description
Ninguna tarea de imán de nevera con este ID pertenece a tu cuenta, o la etapa de la tarea no coincide con la ruta. Revisa el ID y utiliza /prototype o /build para que coincida con la tarea.
Name
500 - Internal Server Error
Description
Meshy no pudo ejecutar la verificación de propiedad intelectual. Vuelve a intentar la solicitud.

DELETE/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Eliminar una tarea de imán de nevera

Cancela una tarea de imán de nevera. Cancelar una tarea PENDING reembolsa sus créditos. Una tarea IN_PROGRESS se cancela sin reembolso, porque un worker ya la ha iniciado. Una tarea con un estado final (SUCCEEDED, FAILED o CANCELED) no se puede cancelar.

La ruta debe coincidir con la etapa de la tarea. Por ejemplo, DELETE en /prototype/:id con el ID de una tarea de compilación devuelve 404.

Request

DELETE

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

Parámetros de ruta

Name
id
Type
path
Description
El ID de la tarea a cancelar.

Devuelve

204 No Content con un cuerpo vacío.

Modos de fallo

Name
400 - Bad Request
Description
Se aplica uno de los siguientes 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.
Name
404 - Not Found
Description
Ninguna tarea de imán de nevera 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.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id/stream

Transmitir en streaming una tarea de imán de nevera

Transmite las actualizaciones de una tarea de imán de nevera como eventos enviados por el servidor (SSE). La ruta debe coincidir con la etapa de la tarea. Si no coincide, por ejemplo el ID de una tarea de build en /prototype/:id/stream, el stream envía un evento error con status_code: 404 y se cierra.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream

curl -N https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Parámetros

Name
id
Type
path
Description
El ID de la tarea proveniente de la respuesta de creación.

Devuelve

Un stream de objetos de tarea prototype o build. Cada evento contiene el objeto de tarea completo, tal como lo devuelve Obtener una tarea de imán de nevera. Mientras la tarea está en PENDING o IN_PROGRESS, sus campos de salida siguen vacíos (null, [] o {}), y finished_at es null.

Si el filtrado de IP bloquea el resultado de la tarea, el stream envía un evento error en su lugar, con el status_code que devolvería una solicitud get.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)

Listar tareas de imán de nevera

Devuelve tus tareas de imán de nevera de una etapa, una página a la vez. La ruta selecciona la etapa. /prototype devuelve solo tareas de prototipo, y /build devuelve solo tareas de construcción.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "type": "creative-lab-fridge-magnet-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729543210000,
    "started_at": 1729543215000,
    "finished_at": 1729543242000,
    "expires_at": 1729802442000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Parámetros de ruta

Name
stage
Type
path
Requerido
Description
La etapa a listar, prototype o build.

Parámetros de consulta

Name
page_num
Type
integer
predeterminado 1
Description
La página a devolver, de 1 a 255. 0 devuelve la primera página. Un valor fuera de 0 a 255 devuelve 400.
Name
page_size
Type
integer
predeterminado 10
Description
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.
Name
sort_by
Type
string
predeterminado -created_at
Description
El orden de clasificación.
Valores disponibles:
- -created_at: más recientes primero
- +created_at: más antiguos primero

Devuelve

Un array de objetos de tarea de prototipo u objetos de tarea de construcción, según la etapa en la ruta.

El objeto de tarea de prototipo de imán de nevera

Una tarea de prototipo genera una imagen de concepto coloreada a partir de una foto. Para convertir la imagen en un modelo 3D, pasa el ID de la tarea al endpoint de build como input_task_id.

Propiedades

Example Fridge Magnet Prototype Task Object

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Name
id
Type
string
Description
El ID de la tarea. No dependas de su formato.
Name
type
Type
string
Description
El tipo de tarea, siempre creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
El name que enviaste al crear la tarea, o "" si no enviaste uno.
Name
status
Type
string
Description
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
Name
progress
Type
integer
Description
Porcentaje del trabajo completado, de 0 a 100. Es 0 hasta que la tarea comienza y 100 cuando tiene éxito.
Name
created_at
Type
timestamp
Description
Momento en que se creó la tarea, en milisegundos Unix.
Name
started_at
Type
timestamp
Description
Momento en que un worker comenzó la tarea, en milisegundos Unix. null hasta entonces.
Name
finished_at
Type
timestamp
Description
Momento en que la tarea alcanzó un estado final, en milisegundos Unix. null hasta entonces.
Name
expires_at
Type
timestamp
Description
Momento en que expira el resultado de la tarea, en milisegundos Unix. Es 3 días después de finished_at, o 3 días después de created_at hasta que la tarea finaliza. Para cuentas Enterprise, que conservan los resultados de la API indefinidamente, es aproximadamente 100 años después. Consulta Retención de recursos.
Name
preceding_tasks
Type
integer
Description
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 resultados de lista.
Name
task_error
Type
object
Description
Por qué falló la tarea. null a menos que status sea FAILED. Consulta Errores.
Name
consumed_credits
Type
integer
Description
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 solo reembolsa una tarea mientras está PENDING. Si Meshy no puede leer el cobro, una respuesta de obtención o de streaming omite el campo, y una solicitud de lista devuelve 500. En ese caso, reintenta la solicitud.
Name
image_urls
Type
array of strings
Description
URLs de descarga para la imagen de concepto. El array tiene una URL después de que la tarea tiene éxito, y está vacío hasta entonces.

El objeto de tarea de construcción de imán de nevera

Una tarea de construcción genera el imán de nevera 3D a partir de una tarea de prototipo exitosa. Devuelve un archivo de modelo en el formato que solicitaste.

Propiedades

Example Fridge Magnet Build Task Object

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Name
id
Type
string
Description
El ID de la tarea. No dependas de su formato.
Name
type
Type
string
Description
El tipo de tarea, siempre creative-lab-fridge-magnet-build.
Name
name
Type
string
Description
El name que enviaste al crear la tarea, o "" si no enviaste uno.
Name
status
Type
string
Description
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
Name
progress
Type
integer
Description
Porcentaje del trabajo completado, de 0 a 100. Es 0 hasta que la tarea comienza y 100 cuando tiene éxito.
Name
created_at
Type
timestamp
Description
Hora en que se creó la tarea, en milisegundos Unix.
Name
started_at
Type
timestamp
Description
Hora en que un worker comenzó la tarea, en milisegundos Unix. null hasta entonces.
Name
finished_at
Type
timestamp
Description
Hora en que la tarea alcanzó un estado final, en milisegundos Unix. null hasta entonces.
Name
expires_at
Type
timestamp
Description
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 termine. Para cuentas Enterprise, que conservan los resultados de la API indefinidamente, es alrededor de 100 años después. Consulta Retención de recursos.
Name
preceding_tasks
Type
integer
Description
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 resultados de listas.
Name
task_error
Type
object
Description
Por qué falló la tarea. null a menos que status sea FAILED. Consulta Errores.
Name
consumed_credits
Type
integer
Description
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 get o stream omite el campo, y una solicitud de lista devuelve 500. En ese caso, reintenta la solicitud.
Name
model_urls
Type
object
Description
URLs de descarga para el archivo de modelo, con una entrada para el output.format que solicitaste. {} hasta que la tarea tenga éxito.
- Name
  glb
  Type
  string
  Description
  URL de descarga para el archivo GLB. Presente cuando output.format es glb.
- Name
  obj
  Type
  string
  Description
  URL de descarga para un archivo zip con model.obj, model.mtl y texture.png. Presente cuando output.format es obj.
- Name
  bundle_zip
  Type
  string
  Description
  URL de descarga para un archivo zip con todos los archivos que genera Meshy. Presente cuando output.format es zip.