Início rápido

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 Plataforma para Programadores — não poderá voltar a vê-la depois deste ecrã, por isso guarde-a num local seguro. Todos os pedidos autenticam-se com um token Bearer no cabeçalho Authorization — consulte Autenticação.

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

Exporte a sua chave e, em seguida, crie a sua primeira tarefa com Imagem para 3D. Prefere trabalhar a partir de um prompt de texto ou de várias fotos? Consulte Texto para 3D ou Multi-imagem para 3D.

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

Todos os exemplos abaixo utilizam esta fotografia — substitua pelo seu próprio image_url para experimentar outra coisa.

Copy image URL

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

Os pedidos devolvem imediatamente um ID de tarefa. Consulte o mesmo endpoint repetidamente até que o status seja SUCCEEDED — substitua <task_id> abaixo pelo ID devolvido no passo 2.

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

{
  "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": ""
  }
}

4Descarregue 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 com tempo limitado — ou, em vez de utilizar a linha de comandos, cole o URL diretamente na barra de endereços do seu navegador para o descarregar.

curl -L "<model_urls.glb from the response above>" -o model.glb

Junte tudo

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

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 },
);
const taskId = created.result;

// 2. Poll until it finishes
let task;
while (true) {
  const { data } = await axios.get(`https://api.meshy.ai/openapi/v1/image-to-3d/${taskId}`, { headers });
  task = data;
  if (task.status === 'SUCCEEDED' || task.status === 'FAILED') break;
  await new Promise((resolve) => setTimeout(resolve, 5000));
}

// 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 fluxos de trabalho comuns

Próximos passos

• Prefere uma interface gráfica? Abra a Plataforma para Programadores — execute pedidos no Playground, acompanhe a utilização e os registos de pedidos, e faça a gestão de webhooks.
• Consulte a referência completa da API para todos os endpoints.
• Verifique 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á a enfrentar problemas? Junte-se à nossa comunidade no Discord — teríamos todo o gosto em ouvi-lo!