Getting Started

1. Get your API keys

1. Sign in to the API Dashboard with your Sloyd account.
2. Open API Keys and set up API billing — a minimum $12 prepaid purchase, converted to credits. See Pricing & Credits.
3. Click Generate Key. Your clientSecret is shown exactly once — copy it somewhere safe. Only the client id and the last 4 characters of the secret are shown again after this.

You now have a client id (sok_live_...) and a client secret. Every request needs both — see Authentication for details.

2. Generate your first model

curl https://api.sloyd.ai/api/jobs/text-to-3d \
  -H "x-client-id: $SLOYD_CLIENT_ID" \
  -H "x-client-secret: $SLOYD_CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "a medieval knight helmet"
  }'

Response:

{ "jobId": "01JZQY4YJ7KV1GQZ9G6H6H2X25" }

3. Poll for completion

curl https://api.sloyd.ai/api/jobs/01JZQY4YJ7KV1GQZ9G6H6H2X25 \
  -H "x-client-id: $SLOYD_CLIENT_ID" \
  -H "x-client-secret: $SLOYD_CLIENT_SECRET"

Poll every few seconds until status is success:

{
  "id": "01JZQY4YJ7KV1GQZ9G6H6H2X25",
  "status": "success",
  "title": "a medieval knight helmet",
  "prompt": "a medieval knight helmet"
}

4. Download the model

Once status is success, the GLB is available at a predictable public URL — no auth required to fetch it:

https://storage.googleapis.com/ai-services-quality/jobs/{jobId}.glb

curl -o helmet.glb \
  https://storage.googleapis.com/ai-services-quality/jobs/01JZQY4YJ7KV1GQZ9G6H6H2X25.glb

That's the whole loop: create → poll → download. Every generation endpoint in this API returns a jobId and follows this exact same pattern — see Jobs for the full response shape and status values.

Next steps

• Authentication — header format and key management.
• Pricing & Credits — what each endpoint costs and how prepaid credits work.
• 3D Generation — full parameter reference for text-to-3d, image-to-3d, and multi-image-to-3d.
• Errors — status codes and error body shapes.