Quickstart

This guide takes you from zero to a downloaded SimReady USD in five minutes.

1. Create an account and mint an API key.

   Sign up at app.rigyd.com, then go to Settings → API Keys and click Create key. Copy the rgyd_live_... token — you only see it once.

   Caution

   Treat the key like a password. It can spend your credits.

2. Submit a conversion.

   Send any 3D file you have. glb is the fastest path because it skips preprocessing.

   curl

   curl -X POST https://api.rigyd.com/api/conversions \
     -H "Authorization: Bearer rgyd_live_..." \
     -F "file=@./model.glb"

   JavaScript

   const form = new FormData();
   form.append('file', new Blob([await fs.readFile('model.glb')]), 'model.glb');
   
   const res = await fetch('https://api.rigyd.com/api/conversions', {
     method: 'POST',
     headers: { Authorization: 'Bearer rgyd_live_...' },
     body: form,
   });
   const { data } = await res.json();
   console.log(data.id); // → "abc123..."

   Python

   import requests
   
   with open("model.glb", "rb") as f:
       res = requests.post(
           "https://api.rigyd.com/api/conversions",
           headers={"Authorization": "Bearer rgyd_live_..."},
           files={"file": ("model.glb", f, "model/gltf-binary")},
       )
   job_id = res.json()["data"]["id"]

   You get back 202 Accepted:

   {
     "data": {
       "id": "abc123...",
       "status": "queued",
       "filename": "model.glb",
       "progress": 0,
       "job_type": "glb_to_simready",
       "credits_charged": 1,
       "createdAt": "2026-05-06T12:00:00.000Z"
     }
   }

3. Poll until it’s done.

   curl https://api.rigyd.com/api/conversions/abc123... \
     -H "Authorization: Bearer rgyd_live_..."

   Status moves through submitting → preprocessing → queued → running → completed | failed. Most jobs finish in under two minutes. See Job lifecycle for the full payload shape.

4. Download the result.

   curl -L "https://api.rigyd.com/api/conversions/abc123.../result?format=usd" \
     -H "Authorization: Bearer rgyd_live_..." \
     -o simready.zip

   The ZIP contains a .usd and its textures. Drop it into Isaac Sim, MuJoCo, or any USD-aware tool.

Next steps

• Try the other modes: 2D → SimReady, Text → SimReady, Simulate
• Build a long-running integration: read Job lifecycle for the full status flow and preprocess component shape
• Hand this site to your AI agent: point it at https://docs.rigyd.com/llms-full.txt