Quickstart

View Markdown llms-full.txt

Choose the path that matches what you already have. Both finish with the same conversion status, validation report, and downloadable USD/MJCF packages.

Before you start

Create a key at app.rigyd.com/api-keys and copy the rgyd_live_... token. You only see it once.

Without a 3D asset

Use SimReady Asset Composer when you are starting from an idea, one reference image, or four ordered views.

The CLI handles creation, polling, submission, and download in one command:

pip install https://github.com/rigyd/rigyd-cli/releases/download/v1.1.0/rigyd-1.1.0-py3-none-any.whl
rigyd login
rigyd compose "compact desktop stapler" \
  --task "press the upper arm to staple paper" \
  --asset-class articulated \
  --export all

Add --review to stop at a generated prototype instead of submitting it automatically. See CLI & Python SDK for images, physical context, and manual submission.

For direct REST integration:

Compose and submit the asset.

curl -X POST https://api.rigyd.com/api/compositions/generate \
  -H "Authorization: Bearer rgyd_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A compact desktop stapler with a plastic shell",
    "robot_task": "Press the upper arm to staple paper",
    "asset_class": "articulated",
    "auto_submit": true
  }'

The response is a composition. Save its data.id.

Poll the composition.
Terminal window
```
curl https://api.rigyd.com/api/compositions/composition-id \
  -H "Authorization: Bearer rgyd_live_..."
```
Poll every 3–5 seconds until data.workflow.status is completed or failed. A completed auto-submit workflow includes data.conversion_job_id; use that ID for the common download steps below.

See SimReady Asset Composer for image inputs, physical context, manual review, and the full workflow response.

With a 3D asset

Use direct conversion when the geometry already exists.

With the CLI, run rigyd convert model.glb --export all. For direct REST integration:

Upload the model.
Terminal window
```
curl -X POST https://api.rigyd.com/api/conversions \
  -H "Authorization: Bearer rgyd_live_..." \
  -F "file=@./model.glb"
```
The response is a conversion job. Save its data.id. GLB is the fastest input because it skips preprocessing; other supported formats are accepted.

Finish either path

Use the conversion-job ID returned directly by the 3D upload or exposed as conversion_job_id by Asset Composer.

Read the conversion and validation result.
Terminal window
```
curl https://api.rigyd.com/api/conversions/conversion-id \
  -H "Authorization: Bearer rgyd_live_..."
```
Wait for data.status to become completed or failed. A completed job includes its SimReady verdict in data.report.validation; badge profiles_passing, not overall.
Download the asset package.
Terminal window
```
curl -L "https://api.rigyd.com/api/conversions/conversion-id/result?format=all" \
  -H "Authorization: Bearer rgyd_live_..." \
  -o simready.zip
```
The archive contains the composed USD tree and, when available, its MJCF package. Keep the USD entry point together with its payloads/ directory.

Next, run a free simulation or review the complete conversion-job lifecycle.