Início rápido

Comece por criar a sua chave de API

Todas as solicitações neste guia necessitam de uma. Criar uma chave leva menos de um minuto.

Crie a sua chave de API

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


1Obtenha a sua chave de API

Crie uma chave de API a partir das configurações da sua conta — não poderá visualizá-la novamente após esta tela, por isso, guarde-a em segurança. Cada pedido é autenticado com um token Bearer no cabeçalho Authorization — veja Autenticação.

Abra as configurações de API no menu de API, em seguida, crie a sua chave


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

Exporte a sua chave, depois crie a sua primeira tarefa com Imagem para 3D. Está a trabalhar a partir de um prompt de texto ou várias fotos? Veja Texto para 3D ou Multi-imagem para 3D.

Exporte a sua chave

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

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

Foto de amostra de um gato utilizada como entrada de Imagem para 3D neste guia
Entrada de amostra

Requisição

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"
  }'

3Verifique o estado da tarefa

As solicitações devolvem uma identificação da tarefa imediatamente. Consulte o mesmo endpoint até que o status seja SUCCEEDED — substitua <task_id> abaixo pela identificação obtida no passo 2.

Requisição

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

Resposta — 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": ""
  }
}

4Descarregue o seu modelo

Capte o modelo a partir de model_urls na resposta acima. Cada formato (GLB, FBX, OBJ, USDZ, STL) é um URL assinado, com tempo limitado — ou salte a linha de comando e cole o URL diretamente na barra de endereços do navegador para o descarregar.

Descarregar

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

Combine tudo

Prefere um script que faz tudo — criar, consultar, descarregar?

Script completo

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. Cria a tarefa
const { data: created } = await axios.post(
  'https://api.meshy.ai/openapi/v1/image-to-3d',
  { image_url: imageUrl },
  { headers },
);
const taskId = created.result;

// 2. Consulta até que termine
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. Descarrega o resultado
const { data: model } = await axios.get(task.model_urls.glb, { responseType: 'arraybuffer' });
fs.writeFileSync('model.glb', model);
console.log('Model.glb guardado');

Explore fluxos de trabalho comuns


Próximos passos