lowpoly será descontinuado a 30/10/2026. Mude de modelo antes destas datas para evitar erros nos pedidos.

Início rápido

Comece por criar a sua chave de API

Todos os pedidos neste guia precisam de uma. Criar uma chave demora segundos.

Criar a sua chave de API

Quatro passos para o seu primeiro modelo 3D, utilizando a API REST da Meshy.


1Obtenha a sua chave de API

Crie uma chave de API na página API Keys da Developer Platform — não conseguirá voltar a visualizá-la depois deste ecrã, por isso guarde-a num local seguro. Todos os pedidos são autenticados com um token Bearer no cabeçalho Authorization — consulte Authentication.

Abra a página API Keys na Developer Platform e, em seguida, crie a sua chave


2Faça o seu primeiro pedido de Imagem para 3D

Exporte a sua chave e, em seguida, crie a sua primeira tarefa com Image to 3D. Está a trabalhar a partir de um prompt de texto ou de várias fotos? Consulte Text to 3D ou Multi-Image to 3D.

Export your key

export MESHY_API_KEY="<your-api-key>"

Cada exemplo abaixo utiliza esta fotografia — substitua pelo seu próprio image_url para experimentar outra coisa.

Sample fantasy character illustration used as the Image to 3D input in this guide
Sample input

Request

POST
/openapi/v1/image-to-3d
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${MESHY_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://docs.meshy.ai/images/api/quick-start/source-photo.webp"
  }'

3Verificar o estado da tarefa

A tarefa é executada em segundo plano e demora normalmente alguns minutos. Faça polling ao mesmo endpoint até que status seja SUCCEEDED, FAILED ou CANCELED, substituindo <task_id> abaixo pelo ID devolvido no passo 2. Para tempos típicos e quanto tempo esperar, consulte Task Lifecycle.

Request

GET
/openapi/v1/image-to-3d/:id
curl https://api.meshy.ai/openapi/v1/image-to-3d/<task_id> \
  -H "Authorization: Bearer ${MESHY_API_KEY}"

Response — SUCCEEDED

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "status": "SUCCEEDED",
  "progress": 100,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "task_error": {
    "message": ""
  }
}

4Transfira o seu modelo

Obtenha o modelo a partir de model_urls na resposta acima. Cada formato (GLB, FBX, OBJ, USDZ, STL) é um URL assinado e limitado no tempo — ou, em vez de usar a linha de comandos, cole o URL diretamente na barra de endereços do seu navegador para o transferir.

Download

model_urls.glb
curl -L "<model_urls.glb from the response above>" -o model.glb
O modelo 3D resultante gerado a partir da fotografia de exemplo da personagem de fantasia
O seu resultado

Juntar tudo

Prefere um único script que faça tudo — criar, consultar, transferir?

Full script

import axios from 'axios';
import fs from 'fs';

const headers = { Authorization: `Bearer ${process.env.MESHY_API_KEY}` };
const imageUrl = 'https://docs.meshy.ai/images/api/quick-start/source-photo.webp';

// 1. Create the task
const { data: created } = await axios.post(
  'https://api.meshy.ai/openapi/v1/image-to-3d',
  { image_url: imageUrl },
  { headers, timeout: 60_000 },
);
const taskId = created.result;

// 2. Poll until it finishes, for up to 60 minutes
const deadline = Date.now() + 60 * 60 * 1000;
let task;
while (true) {
  const { data, headers: resHeaders } = await axios.get(
    `https://api.meshy.ai/openapi/v1/image-to-3d/${taskId}`,
    { headers, timeout: 30_000 },
  );
  task = data;
  if (['SUCCEEDED', 'FAILED', 'CANCELED'].includes(task.status)) break;
  if (Date.now() > deadline) {
    // The task is still running. Check it again later with the same task ID instead of creating a new one.
    throw new Error(`Task ${taskId} is still ${task.status}; check it again later`);
  }
  const waitSeconds = Number(resHeaders['retry-after']) || 5;
  await new Promise((resolve) => setTimeout(resolve, waitSeconds * 1000));
}

// 3. Download the result (only if the task succeeded)
if (task.status !== 'SUCCEEDED') {
  throw new Error(`Task ${task.status}: ${task.task_error?.message || 'unknown error'}`);
}
const { data: model } = await axios.get(task.model_urls.glb, { responseType: 'arraybuffer' });
fs.writeFileSync('model.glb', model);
console.log('Saved model.glb');

Explore common workflows


Próximos passos

  • Prefere uma interface gráfica? Abra a Developer Platform — execute pedidos no Playground, acompanhe a utilização e os registos de pedidos, e faça a gestão de webhooks.
  • Explore a referência da API completa para todos os endpoints.
  • Aprenda com exemplos práticos: siga as receitas passo a passo no Cookbook e leia tutoriais e histórias de criação no Developer Blog.
  • Consulte os Preços, os Limites de Taxa e os Erros antes de passar para produção.
  • Acompanhe o registo de alterações para atualizações e correções de erros.
  • Tem feedback ou está com problemas? Junte-se à nossa comunidade no Discord — adorávamos ouvir a sua opinião!