Inicio rápido

Comienza creando tu clave de API

Cada solicitud de esta guía necesita una. Crear una clave toma segundos.

Crea tu clave de API

Cuatro pasos para obtener tu primer modelo 3D, usando la API REST de Meshy.


1Obtén tu clave de API

Crea una clave de API desde la página API Keys en la Developer Platform — no podrás volver a verla después de esta pantalla, así que guárdala en un lugar seguro. Cada solicitud se autentica con un token Bearer en el encabezado Authorization — consulta Autenticación.

Abre la página de API Keys en la Developer Platform y luego crea tu clave


2Realiza tu primera solicitud de Imagen a 3D

Exporta tu clave, luego crea tu primera tarea con Imagen a 3D. ¿Prefieres trabajar a partir de un prompt de texto o de varias fotos? Consulta Texto a 3D o Multi-imagen a 3D.

Export your key

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

Todos los ejemplos a continuación usan esta foto — sustituye tu propio image_url para probar con otra cosa.

Ilustración de un personaje de fantasía usada como entrada de Imagen a 3D en esta guía
Ejemplo de entrada

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

3Comprueba el estado de la tarea

Las solicitudes devuelven un ID de tarea de inmediato. Consulta el mismo endpoint hasta que status sea SUCCEEDED — reemplaza <task_id> a continuación con el ID devuelto en el paso 2.

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

4Descarga tu modelo

Obtén el modelo desde model_urls en la respuesta anterior. Cada formato (GLB, FBX, OBJ, USDZ, STL) es una URL firmada y de tiempo limitado — o evita la línea de comandos y pega la URL directamente en la barra de direcciones de tu navegador para descargarlo.

Download

model_urls.glb
curl -L "<model_urls.glb from the response above>" -o model.glb
El modelo 3D resultante generado a partir de la foto del personaje de fantasía de ejemplo
Tu resultado

Ponlo todo junto

¿Prefieres un solo script que haga todo el proceso: crear, sondear, descargar?

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 },
);
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');

Explora flujos de trabajo comunes


Próximos pasos

  • ¿Prefieres una interfaz? Abre la Developer Platform — ejecuta solicitudes en el Playground, haz seguimiento del uso y los registros de solicitudes, y gestiona webhooks.
  • Explora la referencia de la API completa para conocer cada endpoint.
  • Consulta Precios, Límites de tasa y Errores antes de pasar a producción.
  • Sigue el registro de cambios para conocer actualizaciones y correcciones de errores.
  • ¿Tienes comentarios o problemas? Únete a nuestra comunidad de Discord — ¡nos encantará saber de ti!