Asset generation is asynchronous. After calling
POST /assets, poll GET /assets/{id} until the status field returns "ready" before exporting.Generate an Asset
A natural-language description of the 3D asset to generate. Be specific about shape, joints, and intended function for best results. Example:
"A 6-DOF industrial robotic arm with a parallel jaw gripper".A human-readable label for the asset. Used for display in the Gizmo dashboard and returned in list responses. Defaults to a truncated version of the prompt if omitted.
An array of string tags for organizing assets. Example:
["gripper", "v2", "warehouse"].POST /assets — Response
Unique identifier for the asset. Use this to poll status and trigger exports.
Current generation status. One of:
pending, processing, ready, failed.Human-readable name assigned to the asset.
The original prompt submitted for generation.
ISO 8601 timestamp of when the generation job was created.
Example Response
Get Asset Status
Retrieve the current status and metadata for a single asset. Poll this endpoint afterPOST /assets to determine when generation is complete.
Path Parameters
The unique identifier of the asset returned by
POST /assets.GET /assets/{id} — Response
Unique identifier for the asset.
Current generation status:
pending, processing, ready, or failed.Human-readable name.
The prompt used to generate this asset.
ISO 8601 creation timestamp.
List of export format strings available for this asset once status is
ready. Values may include isaac_sim_usd, isaac_sim_urdf, and mujoco_mjcf.Example Response (ready)
List Assets
Return a paginated list of all assets associated with your API key.Query Parameters
Maximum number of assets to return. Defaults to
20. Maximum is 100.Number of assets to skip before returning results. Use with
limit to paginate. Defaults to 0.GET /assets — Response
Array of asset objects, each with
id, status, name, prompt, and created_at.Total number of assets in your account, regardless of pagination.
The
limit value applied to this response.The
offset value applied to this response.Example Response
Export an Asset
Request a download URL for an asset in a specific simulator format. The asset must havestatus: "ready" before export.
Path Parameters
The unique identifier of the asset to export.
Body Parameters
The export format. Must be one of:
| Value | Description |
|---|---|
isaac_sim_usd | Universal Scene Description (USD) for NVIDIA Isaac Sim |
isaac_sim_urdf | URDF for use in Isaac Sim’s URDF importer |
mujoco_mjcf | MuJoCo XML (MJCF) for direct use in MuJoCo simulations |
POST /assets/{id}/export — Response
A pre-signed URL to download the exported asset file. This URL is time-limited.
ISO 8601 timestamp indicating when the
download_url expires. Download the file before this time; re-request the export if the URL has expired.Example Response