Composition workflows
Asset Composer and SimReady conversion are two linked resources:
| Resource | Owns | Read endpoint |
|---|---|---|
| Composition | Intent, references, simulation brief, prototype, and automation progress | GET /api/compositions/:id |
| Conversion job | SimReady processing, validation report, USD/MJCF outputs, and simulations | GET /api/conversions/:id |
With auto_submit=true, poll the composition until its workflow completes. Its conversion_job_id then links to the conversion record and downloadable result. With auto_submit=false, the composition stops at ready until you call POST /api/compositions/:id/submit.
Retrieve a composition
Section titled “Retrieve a composition”curl https://api.rigyd.com/api/compositions/composition-id \ -H "Authorization: Bearer rgyd_live_..."Read data.workflow.status, stage, and progress while the composition runs. Terminal statuses are ready, completed, failed, and cancelled; running is non-terminal.
List compositions
Section titled “List compositions”curl "https://api.rigyd.com/api/compositions?page=1&pageSize=25" \ -H "Authorization: Bearer rgyd_live_..."The endpoint returns your composition workflows newest first. It does not return conversion-only jobs. Use GET /api/conversions for direct 3D conversions and the SimReady jobs created from submitted compositions.
For creation parameters and the full workflow response, see SimReady Asset Composer.