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
Using with AI Agents
If you're pointing an AI agent at MeshRoom, sign up and generate an API key yourself first, then hand the agent the key - don't ask an agent to sign up on your behalf. Signup is rate-limited and screened server-side (disposable email domains and per-IP account caps are rejected), so an agent-driven signup attempt won't work anyway.
We publish /llms.txt for agents that need machine-readable guidance on the public pages and API endpoints, including this same rule.
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.
Your First Request
Generate a 3D model with a single cURL command. The API accepts a JSON body with a mode and prompt.
Understanding the Response
Generation runs asynchronously. The request above returns immediately - credits are charged up front - with a generation id to poll:
Poll the same id until it finishes:
| Field | Type | Description |
|---|---|---|
| id | string | Unique generation identifier - use this to poll |
| status | string | "pending" → mode-specific steps → "complete" or "failed" |
| modelUrl / imageUrl | string | Direct URL to the generated asset file, once complete |
| assetId | string | Id of the saved asset, once complete - visible in your dashboard |
| creditsRemaining | number | Your balance after this generation was charged |