Skip to content

Composition workflows

View Markdown llms-full.txt

Asset Composer and SimReady conversion are two linked resources:

ResourceOwnsRead endpoint
CompositionIntent, references, simulation brief, prototype, and automation progressGET /api/compositions/:id
Conversion jobSimReady processing, validation report, USD/MJCF outputs, and simulationsGET /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.

Terminal window
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.

Terminal window
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.