lowpoly será descontinuado a 30/10/2026. Mude de modelo antes destas datas para evitar erros nos pedidos. Ver todas as descontinuações

API Creative Lab íman de frigorífico

Transforme uma fotografia num íman de frigorífico imprimível em 3D, com um relevo colorido e um verso plano, em duas etapas. Uma tarefa de protótipo gera uma imagem conceptual colorizada a partir da fotografia. Uma tarefa de construção transforma essa imagem num modelo 3D em relevo, e utiliza o ID da tarefa de protótipo 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

Criar uma tarefa de prototype de íman de frigorífico

Gera uma imagem de conceito colorida a partir de uma fotografia. Para criar o modelo 3D, passe o ID desta tarefa para o endpoint de build como input_task_id. Para os campos da tarefa, consulte O objeto de tarefa de prototype do íman de frigorífico.

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
    Obrigatório
    Description

    A fotografia a transformar numa imagem de conceito de íman de frigorífico, como um URL público ou um data URI (data:image/jpeg;base64,<os seus dados de imagem codificados em base64>).

    A imagem tem de ser um ficheiro JPG, JPEG, PNG ou WebP de, no máximo, 20 MB.

  • Name
    name
    Type
    string
    Description

    Um nome para a tarefa, até 100 caracteres. É devolvido no campo name da tarefa. Um nome mais longo devolve 400.

  • Name
    remove_background
    Type
    boolean
    predefinição false
    Description

    Se deve remover o fundo da imagem de prototype. true devolve um PNG RGBA transparente que mantém o íman inteiro, para que o possa colocar sobre qualquer fundo. O build também parte da imagem sem o fundo. Se a Meshy não conseguir remover o fundo, devolve a imagem com o fundo, e a tarefa continua a ser bem-sucedida.

    A opção remove_background do build é independente.

Retorno

O campo result contém o ID da nova tarefa de prototype. Obtenha a tarefa ou transmita-a em stream até que status seja SUCCEEDED. Depois, passe o ID para o endpoint de build como input_task_id.

Modos de falha

  • Name
    400 - Bad Request
    Description

    O pedido não pode ser executado. Por exemplo:

    • image_url está em falta.
    • A imagem não é um ficheiro JPG, JPEG, PNG ou WebP.
    • A imagem é demasiado pequena, excede 20 MB, ou excede o número máximo de píxeis.
    • A Meshy não consegue transferir a imagem, por exemplo porque o URL devolve 404 ou expira o tempo limite.
    • O data URI não é um base64 válido.
    • A imagem foi assinalada como NSFW.

    A mensagem de erro indica qual foi o problema encontrado. Corrija o pedido e envie-o novamente.

  • Name
    401 - Unauthorized
    Description

    A chave de API está em falta ou é inválida. Verifique o cabeçalho Authorization.

  • Name
    402 - Payment Required
    Description

    Aplica-se uma das seguintes situações:

    • A conta não tem créditos suficientes.
    • A chave de API, o espaço de trabalho ou o membro atingiu o respetivo limite de créditos.
    • A conta está no plano gratuito.

    Verifique os seus créditos e o seu plano e tente novamente.

  • Name
    403 - Forbidden
    Description

    A sua equipa tem a opção IP Filtering ativada, e a Meshy assinalou a imagem por propriedade intelectual de terceiros. Envie uma imagem que tenha o direito de utilizar.

  • Name
    429 - Too Many Requests
    Description

    Um destes limites foi atingido:

    • Enviou mais pedidos do que o permitido pelo seu limite de taxa. Aguarde alguns segundos e tente novamente. Consulte Limites de taxa.
    • Demasiadas das suas tarefas estão em fila de espera ou em execução. Aguarde que algumas terminem e tente novamente.
    • Num plano ilimitado sem créditos restantes, atingiu o número de tarefas que podem ser executadas sem créditos. Aguarde que uma tarefa termine, ou adicione créditos.
  • Name
    500 - Internal Server Error
    Description

    A Meshy encontrou um erro de servidor, por exemplo porque não conseguiu executar a verificação de propriedade intelectual na imagem. A Meshy não cria a tarefa e reembolsa quaisquer créditos cobrados. Tente novamente o pedido.


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

Criar uma tarefa de criação (build) de íman de frigorífico

Gera o modelo 3D imprimível do íman de frigorífico a partir de uma tarefa de protótipo bem-sucedida. A Meshy transforma a imagem conceptual do protótipo num relevo em mapa de profundidade e devolve um ficheiro de modelo no formato que escolher. Para os campos da tarefa, consulte O objeto da tarefa de criação de Íman de Frigorífico.

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
    Obrigatório
    Description

    O ID da tarefa de protótipo a criar. Tem de ser uma tarefa criada pela sua conta com POST /openapi/creative-lab/fridge-magnet/v1/prototype, com o estado SUCCEEDED.

    Um ID que não corresponda a uma das suas tarefas de protótipo de Íman de Frigorífico da API devolve 404, incluindo um protótipo criado na aplicação web.

  • Name
    name
    Type
    string
    Description

    Um nome para a tarefa, com um máximo de 100 carateres. É devolvido no campo name da tarefa. Um nome mais longo devolve 400.

options

Definições opcionais para a forma do relevo. Todos os campos têm um valor predefinido, pelo que só precisa de enviar os que pretende alterar. Um valor fora do intervalo de um campo devolve 400.

  • Name
    badge_shape
    Type
    string
    predefinição rounded-rect
    Description

    O contorno do íman quando a Meshy não o traça a partir do sujeito. A Meshy usa-o quando remove_background é false, ou quando não consegue encontrar o contorno do sujeito.

    Valores disponíveis:

    • circle
    • rounded-rect
    • hexagon
    • shield
    • star
  • Name
    size_mm
    Type
    number
    predefinição 60
    Description

    O comprimento da aresta do quadrado delimitador do íman, em milímetros, até 400. 0 usa o valor predefinido.

  • Name
    relief_height_mm
    Type
    number
    predefinição 3.3
    Description

    A altura máxima do relevo acima da base, em milímetros, de 0 a 20.

  • Name
    relief_offset_mm
    Type
    number
    predefinição 0
    Description

    Quanto baixar o relevo, em milímetros, de 0 a 20. A Meshy subtrai este valor à altura do relevo em todos os pontos, até à base.

  • Name
    base_thickness_mm
    Type
    number
    predefinição 2.0
    Description

    A espessura da placa de base plana por trás do relevo, em milímetros, de 0 a 20. A base predefinida de 2 mm dá ao íman corpo suficiente para aderir ao frigorífico, para que o relevo não pareça frágil.

  • Name
    has_closed_back
    Type
    boolean
    predefinição true
    Description

    Se deve fechar a parte de trás do íman, o lado onde se cola o íman. false deixa a parte de trás aberta, como uma casca.

  • Name
    relief_curve
    Type
    string
    predefinição linear
    Description

    A curva que mapeia os valores do mapa de profundidade para a altura do relevo.

    Valores disponíveis:

    • linear
    • gamma
    • s-curve
  • Name
    curve_param
    Type
    number
    predefinição 1.0
    Description

    A intensidade da curva, até 10. As curvas gamma e s-curve usam-na, e linear ignora-a. 0 usa o valor predefinido.

  • Name
    invert_depth
    Type
    boolean
    predefinição false
    Description

    Se deve inverter o mapa de profundidade, para que as áreas mais escuras se tornem relevo mais elevado.

  • Name
    smoothing
    Type
    number
    predefinição 0.24
    Description

    Quanto suavizar o mapa de profundidade antes de a Meshy criar o relevo, de 0 a 10.

  • Name
    relief_scale
    Type
    number
    predefinição 1.0
    Description

    Quanto ampliar o relevo e a sua textura dentro do contorno, em torno do centro, até 10. Um valor superior a 1 amplia o sujeito, e um valor inferior a 1 reduz-o. Não altera a altura do relevo. 0 usa o valor predefinido.

  • Name
    depth_threshold
    Type
    number
    predefinição 0.1
    Description

    O valor do mapa de profundidade abaixo do qual a Meshy define a profundidade como zero, de 0 a 1.

  • Name
    remove_background
    Type
    boolean
    predefinição true
    Description

    Se deve traçar o contorno do íman a partir do sujeito, para que o íman siga a forma do sujeito. false usa antes o contorno badge_shape. A Meshy também usa badge_shape quando não consegue encontrar o contorno do sujeito.

    Isto é independente do parâmetro remove_background do protótipo, que define se a imagem do protótipo tem um fundo transparente.

  • Name
    export_resolution
    Type
    integer
    predefinição 512
    Description

    A resolução de malha do modelo exportado, de 64 a 512. A Meshy constrói a geometria a partir de um mapa de profundidade de 512 píxeis, pelo que uma malha mais fina acrescentaria faces sem acrescentar detalhe. 0 usa o valor predefinido.

output

Opcional. Define o formato de ficheiro devolvido pela criação.

  • Name
    format
    Type
    string
    predefinição glb
    Description

    O formato de ficheiro devolvido pela criação.

    Valores disponíveis:

    • glb: um ficheiro model.glb, em model_urls.glb
    • obj: um ficheiro zip com model.obj, model.mtl e texture.png, em model_urls.obj
    • zip: um ficheiro zip com todos os ficheiros gerados pela Meshy, em model_urls.bundle_zip

Devoluções

O campo result contém o ID da nova tarefa de criação. Obtenha a tarefa ou transmita-a em fluxo até que status seja SUCCEEDED. Depois, transfira o ficheiro a partir da única entrada em model_urls.

Modos de falha

  • Name
    400 - Bad Request
    Description

    O pedido não pode ser executado. Por exemplo:

    • input_task_id está em falta ou não é um ID de tarefa válido.
    • O estado da tarefa de protótipo não é SUCCEEDED. Se ainda estiver em execução, aguarde e tente novamente. Se tiver falhado ou sido cancelada, crie uma nova tarefa de protótipo.
    • A tarefa de protótipo foi bem-sucedida, mas não tem imagem. Crie uma nova tarefa de protótipo.
    • Um campo de options está fora do seu intervalo ou não é um valor disponível.

    A mensagem de erro indica qual o problema encontrado.

  • Name
    401 - Unauthorized
    Description

    A chave de API está em falta ou é inválida. Verifique o cabeçalho Authorization.

  • Name
    402 - Payment Required
    Description

    Aplica-se uma das seguintes situações:

    • A conta não tem créditos suficientes.
    • A chave de API, o espaço de trabalho ou o membro atingiu o seu limite de créditos.
    • A conta está no plano gratuito.

    Verifique os seus créditos e plano, depois tente novamente.

  • Name
    404 - Not Found
    Description

    input_task_id não corresponde a nenhuma tarefa de protótipo de Íman de Frigorífico criada pela sua conta através da API. Um protótipo criado na aplicação web também devolve 404. Envie o ID result de uma resposta de criação de protótipo.

  • Name
    429 - Too Many Requests
    Description

    Um dos seguintes limites foi atingido:

    • Enviou mais pedidos do que o seu limite de taxa permite. Aguarde alguns segundos e tente novamente. Consulte Limites de taxa.
    • Demasiadas das suas tarefas estão em fila de espera ou em execução. Aguarde que algumas terminem e tente novamente.
    • Num plano ilimitado sem créditos restantes, atingiu o número de tarefas que podem ser executadas sem créditos. Aguarde que uma tarefa termine, ou adicione créditos.

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

Obter uma tarefa de íman de frigorífico

Devolve uma tarefa de prototype ou de build. O caminho deve corresponder à fase da tarefa. Uma tarefa de build pedida através de /prototype/:id devolve 404, e o mesmo acontece com uma tarefa de prototype pedida através de /build/:id.

Para os campos, consulte O objeto de tarefa de prototype do íman de frigorífico e O objeto de tarefa de build do íman de frigorífico.

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

    O ID da tarefa proveniente da resposta de criação.

Devolve

O objeto de tarefa de prototype ou o objeto de tarefa de build, consoante a fase indicada no caminho.

Modos de falha

  • Name
    400 - Bad Request
    Description

    id não é um ID de tarefa válido. Envie o ID result da resposta de criação.

  • Name
    403 - Forbidden
    Description

    A sua equipa tem a opção IP Filtering ativada, e a Meshy sinalizou a imagem da tarefa de prototype por propriedade intelectual de terceiros. As tarefas de build e as equipas no plano Enterprise não recebem este erro. Crie uma tarefa de prototype a partir de uma imagem sobre a qual tenha direitos de utilização.

  • Name
    404 - Not Found
    Description

    Nenhuma tarefa de íman de frigorífico com este ID pertence à sua conta, ou a fase da tarefa não corresponde ao caminho. Verifique o ID e utilize /prototype ou /build para corresponder à tarefa.

  • Name
    500 - Internal Server Error
    Description

    A Meshy não conseguiu executar a verificação de propriedade intelectual. Repita o pedido.


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

Eliminar uma tarefa de íman de frigorífico

Cancela uma tarefa de íman de frigorífico. Cancelar uma tarefa PENDING reembolsa os seus créditos. Uma tarefa IN_PROGRESS é cancelada sem reembolso, porque um worker já a iniciou. Uma tarefa com um estado final (SUCCEEDED, FAILED ou CANCELED) não pode ser cancelada.

O caminho tem de corresponder à etapa da tarefa. Por exemplo, DELETE em /prototype/:id com o ID de uma tarefa de build devolve 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 caminho

  • Name
    id
    Type
    path
    Description

    O ID da tarefa a cancelar.

Retorna

204 No Content com um corpo vazio.

Modos de falha

  • Name
    400 - Bad Request
    Description

    Aplica-se uma destas situações:

    • id não é um ID de tarefa válido. Envie o ID result da resposta de criação.
    • A tarefa já tem um estado final (SUCCEEDED, FAILED ou CANCELED), pelo que não pode ser cancelada.
  • Name
    404 - Not Found
    Description

    Nenhuma tarefa de íman de frigorífico com este ID pertence à sua conta, ou a etapa da tarefa não corresponde ao caminho. Verifique o ID e utilize /prototype ou /build para corresponder à tarefa.


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

Transmitir uma tarefa de Íman de Frigorífico em stream

Transmite as atualizações de uma tarefa de Íman de Frigorífico como Server-Sent Events (SSE). O caminho tem de corresponder à fase da tarefa. Se não corresponder, por exemplo o ID de uma tarefa de build em /prototype/:id/stream, o stream envia um único evento error com status_code: 404 e é encerrado.

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

    O ID da tarefa proveniente da resposta de criação.

Devolve

Um stream de objetos de tarefa prototype ou build. Cada evento contém o objeto de tarefa completo, tal como Obter uma tarefa de Íman de Frigorífico o devolve. Enquanto a tarefa estiver PENDING ou IN_PROGRESS, os seus campos de saída continuam vazios (null, [] ou {}), e finished_at é null.

Se a Filtragem de IP bloquear o resultado da tarefa, o stream envia, no seu lugar, um evento error com o status_code que um pedido get devolveria.


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

Listar tarefas de Fridge Magnet

Devolve as suas tarefas de Fridge Magnet de um estágio, uma página de cada vez. O caminho seleciona o estágio. /prototype devolve apenas tarefas de protótipo, e /build devolve apenas tarefas de construção.

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 caminho

  • Name
    stage
    Type
    path
    Obrigatório
    Description

    O estágio a listar, prototype ou build.

Parâmetros de consulta

  • Name
    page_num
    Type
    integer
    predefinição 1
    Description

    A página a devolver, de 1 a 255. 0 devolve a primeira página. Um valor fora de 0 a 255 devolve 400.

  • Name
    page_size
    Type
    integer
    predefinição 10
    Description

    Número de tarefas por página, até 100. Um valor de 101 a 255 devolve 100 tarefas, e 0 utiliza o valor predefinido. Um valor fora de 0 a 255 devolve 400.

  • Name
    sort_by
    Type
    string
    predefinição -created_at
    Description

    A ordem de ordenação.

    Valores disponíveis:

    • -created_at: mais recentes primeiro
    • +created_at: mais antigos primeiro

Retorna

Um array de objetos de tarefa de protótipo ou objetos de tarefa de construção, correspondente ao estágio indicado no caminho.


O objeto de tarefa de protótipo Fridge Magnet

Uma tarefa de protótipo gera uma imagem de conceito colorida a partir de uma fotografia. Para transformar a imagem num modelo 3D, passe o ID da tarefa para o endpoint de construção como input_task_id.

Propriedades

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

    O ID da tarefa. Não dependa do seu formato.

  • Name
    type
    Type
    string
    Description

    O tipo de tarefa, sempre creative-lab-fridge-magnet-prototype.

  • Name
    name
    Type
    string
    Description

    O name que enviou ao criar a tarefa, ou "" se não tiver enviado nenhum.

  • Name
    status
    Type
    string
    Description

    O estado da tarefa.

    Valores disponíveis:

    • PENDING: a aguardar na fila
    • IN_PROGRESS: a gerar o resultado
    • SUCCEEDED: final, com o resultado
    • FAILED: final, com o motivo em task_error
    • CANCELED: final, sem resultado
  • Name
    progress
    Type
    integer
    Description

    Percentagem do trabalho concluído, de 0 a 100. É 0 até a tarefa começar e 100 quando é bem-sucedida.

  • Name
    created_at
    Type
    timestamp
    Description

    Momento em que a tarefa foi criada, em milissegundos Unix.

  • Name
    started_at
    Type
    timestamp
    Description

    Momento em que um worker iniciou a tarefa, em milissegundos Unix. null até isso acontecer.

  • Name
    finished_at
    Type
    timestamp
    Description

    Momento em que a tarefa atingiu um estado final, em milissegundos Unix. null até isso acontecer.

  • Name
    expires_at
    Type
    timestamp
    Description

    Momento em que o resultado da tarefa expira, em milissegundos Unix. É 3 dias após finished_at, ou 3 dias após created_at até a tarefa terminar. Para contas Enterprise, que mantêm os resultados da API indefinidamente, é cerca de 100 anos depois. Consulte Retenção de recursos.

  • Name
    preceding_tasks
    Type
    integer
    Description

    A posição da tarefa na fila enquanto está PENDING. 1 significa que é a próxima a começar. 0 depois de a tarefa sair da fila, e sempre 0 em resultados de listagem.

  • Name
    task_error
    Type
    object
    Description

    O motivo pelo qual a tarefa falhou. null a menos que status seja FAILED. Consulte Erros.

  • Name
    consumed_credits
    Type
    integer
    Description

    Número de créditos cobrados pela tarefa, após qualquer reembolso. Um pedido que devolva um erro não é cobrado. Uma tarefa falhada é 0, porque a Meshy a reembolsa. Cancelar só reembolsa uma tarefa enquanto esta estiver PENDING. Se a Meshy não conseguir ler a cobrança, uma resposta de obtenção ou de stream omite o campo, e um pedido de listagem devolve 500. Nesse caso, repita o pedido.

  • Name
    image_urls
    Type
    array of strings
    Description

    URLs de transferência para a imagem de conceito. O array tem um URL depois de a tarefa ser bem-sucedida, e está vazio até lá.


O objeto de tarefa de build do íman de frigorífico

Uma tarefa de build gera o íman de frigorífico 3D a partir de uma tarefa de protótipo bem-sucedida. Devolve um ficheiro de modelo no formato que pediu.

Propriedades

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

    O ID da tarefa. Não dependa do seu formato.

  • Name
    type
    Type
    string
    Description

    O tipo da tarefa, sempre creative-lab-fridge-magnet-build.

  • Name
    name
    Type
    string
    Description

    O name que enviou quando criou a tarefa, ou "" se não tiver enviado nenhum.

  • Name
    status
    Type
    string
    Description

    O estado da tarefa.

    Valores disponíveis:

    • PENDING: a aguardar na fila
    • IN_PROGRESS: a gerar o resultado
    • SUCCEEDED: final, com o resultado
    • FAILED: final, com o motivo em task_error
    • CANCELED: final, sem resultado
  • Name
    progress
    Type
    integer
    Description

    Percentagem do trabalho concluído, de 0 a 100. É 0 até a tarefa começar e 100 quando é bem-sucedida.

  • Name
    created_at
    Type
    timestamp
    Description

    Momento em que a tarefa foi criada, em milissegundos Unix.

  • Name
    started_at
    Type
    timestamp
    Description

    Momento em que um worker iniciou a tarefa, em milissegundos Unix. null até isso acontecer.

  • Name
    finished_at
    Type
    timestamp
    Description

    Momento em que a tarefa atingiu um estado final, em milissegundos Unix. null até isso acontecer.

  • Name
    expires_at
    Type
    timestamp
    Description

    Momento em que o resultado da tarefa expira, em milissegundos Unix. É 3 dias após finished_at, ou 3 dias após created_at até a tarefa terminar. Para contas Enterprise, que mantêm os resultados da API indefinidamente, é cerca de 100 anos depois. Consulte Retenção de recursos.

  • Name
    preceding_tasks
    Type
    integer
    Description

    A posição da tarefa na fila enquanto está PENDING. 1 significa que começa a seguir. 0 depois de a tarefa sair da fila, e sempre 0 em resultados de listagem.

  • Name
    task_error
    Type
    object
    Description

    Porque a tarefa falhou. null a menos que status seja FAILED. Consulte Erros.

  • Name
    consumed_credits
    Type
    integer
    Description

    Número de créditos cobrados pela tarefa, após qualquer reembolso. Um pedido que devolve um erro não é cobrado. Uma tarefa falhada é 0, porque a Meshy reembolsa-a. O cancelamento só reembolsa uma tarefa enquanto esta está PENDING. Se a Meshy não conseguir ler a cobrança, uma resposta de get ou stream omite o campo, e um pedido de listagem devolve 500. Nesse caso, tente novamente o pedido.

  • Name
    model_urls
    Type
    object
    Description

    URLs de transferência para o ficheiro de modelo, com uma entrada para o output.format que pediu. {} até a tarefa ser bem-sucedida.

    • Name
      glb
      Type
      string
      Description

      URL de transferência do ficheiro GLB. Presente quando output.format é glb.

    • Name
      obj
      Type
      string
      Description

      URL de transferência de um ficheiro zip com model.obj, model.mtl e texture.png. Presente quando output.format é obj.

    • Name
      bundle_zip
      Type
      string
      Description

      URL de transferência de um ficheiro zip com todos os ficheiros que a Meshy gera. Presente quando output.format é zip.