Download result

Download the result of a completed SimReady conversion as a ZIP archive. Use the conversion-job ID from a direct 3D upload or from Asset Composer’s conversion_job_id; composition IDs do not work on this endpoint.

Method	GET
Path	/api/conversions/:id/result
Returns	streaming application/zip

Query parameters

Param	Values	Default	Notes
format	usd · mjcf · all	all	usd = USD + textures only. mjcf = MuJoCo XML package. all = both.

Examples

curl

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

JavaScript

import fs from 'node:fs';
import { Readable } from 'node:stream';

const res = await fetch(
  `https://api.rigyd.com/api/conversions/${jobId}/result?format=usd`,
  { headers: { Authorization: `Bearer ${process.env.RIGYD_API_KEY}` } },
);
if (!res.ok) throw new Error(`HTTP ${res.status}`);
await new Promise((resolve, reject) => {
  Readable.fromWeb(res.body)
    .pipe(fs.createWriteStream('simready.zip'))
    .on('finish', resolve).on('error', reject);
});

Python

import os, requests

with requests.get(
    f"https://api.rigyd.com/api/conversions/{job_id}/result",
    headers={"Authorization": f"Bearer {os.environ['RIGYD_API_KEY']}"},
    params={"format": "usd"},
    stream=True,
) as res:
    res.raise_for_status()
    with open("simready.zip", "wb") as out:
        for chunk in res.iter_content(chunk_size=1024 * 1024):
            out.write(chunk)

ZIP contents

<name> below is the asset name chosen by the pipeline, which is not always your uploaded filename. <basename> is your uploaded filename without its extension.

format=usd

usd/<name>/<name>.usd            # entry point — open this one
usd/<name>/payloads/*.usd        # base, meshes, physics layers
usd/<name>/payloads/materials/OmniPBR/*.mdl  # when an MDL material is used
usd/<name>/textures/*.png

format=mjcf

mjcf/<name>.xml
mjcf/meshes/*.obj      # visual meshes, with UVs
mjcf/meshes/*.stl      # collision hulls
mjcf/textures/*.png

format=all

usd/<name>/<name>.usd            # entry point — open this one
usd/<name>/payloads/*.usd        # base, meshes, physics layers
usd/<name>/payloads/materials/OmniPBR/*.mdl  # when an MDL material is used
usd/<name>/textures/*.png
mjcf/<name>.xml
mjcf/meshes/*.obj
mjcf/meshes/*.stl
mjcf/textures/*.png

The USD is composed — open the entry point, keep the tree

usd/<name>/<name>.usd is a kind = "component" entry point that references payloads/<name>_base.usd and payloads payloads/<name>_physics.usd. Extracting that one file and loading it gives you an empty stage. Unzip the whole usd/<name>/ directory and point your loader at the entry point; the root layer is also the first entry in the archive, which is what three.js’s USDLoader reads.

Assets delivered before the composition change are still one flat file under usd/<basename>/, and archives already downloaded are not rewritten — so handle both shapes if you store them.

The MJCF tree lost a folder level

The MuJoCo package used to nest everything one level deeper — mjcf/<name>/<name>.xml, mjcf/<name>/meshes/…. It is now flat under mjcf/, as shown above.

This came from a SimReady conformance fix upstream: NP.005 (asset-folder-structure) wants an asset root with exactly one intermediate folder, and the extra level made NVIDIA’s validator read the asset root as literally "mjcf" and then ask the filename to contain it.

If you address files by path inside the archive, check that code. Globbing for *.xml or *.stl anywhere under the root is unaffected. Already-downloaded archives are not rewritten, so if you store them you may need to handle both shapes.

Errors specific to this endpoint

Status	Body	When
400	{ "error": "Invalid format. Expected one of: usd, mjcf, all" }	Bad format value
404	{ "error": "Conversion job not found" }	Bad id or not your job
404	{ "error": "MJCF package is not available for this conversion" }	format=mjcf but the pipeline did not produce an MJCF package
409	{ "error": "Job not yet completed", "status": "running" }	Job is still in flight
502	upstream fetch failure	Underlying media store unreachable

Tip

Result downloads are unauthenticated after the redirect — the URL is signed and short-lived. Don’t cache them long-term; re-call this endpoint when you need the result again.