Getting Started
Set up your API key and make your first generation request in under 5 minutes.
Prerequisites
Before you begin, you will need:
- A MeshRoom account — sign up free
- An API key from your dashboard
Every new account receives 10 free credits — enough to try all three generation modes without spending a dime.
Authentication
All API requests require an API key passed in the Authorization header. You can generate keys from the API Keys page in your dashboard.
Authorization: Bearer mr_live_xxxxxxxxxxxx
Keep your API key secret. Never expose it in client-side code or public repositories. If compromised, rotate it immediately from the dashboard.
Your First Request
Generate a 3D model with a single cURL command. The API accepts a JSON body with a mode and prompt.
curl -X POST https://meshroom.app/api/v1/generate \
-H "Authorization: Bearer mr_live_..." \
-H "Content-Type: application/json" \
-d '{
"mode": "trellis",
"prompt": "a medieval treasure chest",
"options": {
"meshSimplify": 0.95,
"textureSize": 1024
}
}'
Understanding the Response
A successful generation returns a JSON object with the asset URL and credit usage:
{
"id": "gen_abc123",
"status": "completed",
"mode": "trellis",
"model_url": "https://meshroom.app/assets/gen_abc123.glb",
"credits_used": 2
}
| Field | Type | Description |
|---|---|---|
| id | string | Unique generation identifier |
| status | string | "completed", "processing", or "failed" |
| model_url | string | Direct URL to the generated asset file |
| credits_used | number | Number of credits deducted for this generation |