Appearance
Sloyd API
The Sloyd API generates 3D models from a text prompt or an image — all from a single HTTP call. Send a prompt or an image, get back a jobId, poll until it's done, then download a ready-to-use GLB.
Base URL
https://api.sloyd.ai/apiEvery path in this reference is relative to that base. For example, POST /jobs/text-to-3d means:
POST https://api.sloyd.ai/api/jobs/text-to-3dWhat you can do
| Task | Endpoint |
|---|---|
| Generate a 3D model from text | POST /jobs/text-to-3d |
| Generate a 3D model from one image | POST /jobs/image-to-3d |
| Generate a 3D model from multiple images | POST /jobs/multi-image-to-3d |
| Check job status and get the result | GET /jobs/{jobId} |
The generation model
Every generation endpoint follows the same shape:
- You
POSTa request and immediately get back{ "jobId": "..." }. This happens in under a second — generation itself keeps running in the background. - You poll
GET /jobs/{jobId}untilstatusissuccess(orerror). - Once
statusissuccess, the finished file is available from a public URL derived from the job id — no further request needed. See Jobs → Downloading the result.
Start with Getting Started for a full working example, or jump straight to Authentication to get your keys.