Skip to content

Rigyd API

Start with an idea, reference images, or an existing 3D file. End with a physics-enabled SimReady asset.
Quickstart Get an API key

What you can do

Section titled “What you can do”
SimReady Asset Composer Describe the object and its robotic task, optionally add reference images, and generate a rigid or articulated SimReady asset.
3D → SimReady Already have a model? Upload it and add physics, collision, materials, USD, and MJCF without generating a new prototype.
Simulate Run a demo or drop physics simulation against a completed conversion. Returns a video, GIF, and log.
SimReady Validation Every conversion is checked against the SimReady Foundation specification before it ships. See what we cover today.

Ways to use it

Section titled “Ways to use it”
REST API Submit, poll, and download over HTTP. Start with the Quickstart.
CLI & Python SDK CLI v1.1 — compose from intent or convert existing 3D assets from terminal and Python.
Isaac Sim extension Convert existing 3D assets and load SimReady USD straight onto your stage inside NVIDIA Isaac Sim.

How it fits together

Section titled “How it fits together”

Rigyd has two entry paths. Asset Composer starts from intent and optional references; direct conversion starts from a 3D file. Both converge on the same SimReady conversion and download APIs.

POST /api/compositions/generate ─► GET /api/compositions/:id
  text + optional images             │ conversion_job_id
                                     ▼
POST /api/conversions ───────────► GET /api/conversions/:id
  existing 3D file                    │ status === "completed"
                                      ▼
                         GET /api/conversions/:id/result

Where to start

Section titled “Where to start”
Quickstart Choose CLI or REST, then create your first SimReady asset.
Authentication The one header you need to send.
Job lifecycle Status enum, preprocessing, response shapes.
Errors What every status code means.

Account & billing

Section titled “Account & billing”

Credits are prepaid one-time top-ups at $1 per credit; there is no subscription or automatic monthly reset. Buy credits and view credit history at app.rigyd.com/billing. Mint and manage API keys at app.rigyd.com/api-keys. These account flows are not part of the public API.