# Gizmo ## Docs - [API Access](https://docs.gizmo.antimlabs.com/api-access.md): Programmatic REST API for automated simulation authoring - [API key usage stats](https://docs.gizmo.antimlabs.com/api-reference/account/api-key-usage-stats.md): Get usage statistics for all your API keys — request counts, last used timestamps, and rate limit configuration. - [Current user info](https://docs.gizmo.antimlabs.com/api-reference/account/current-user-info.md): Returns identity information for the authenticated API key — useful for verifying your key works and checking scopes. - [Delete asset](https://docs.gizmo.antimlabs.com/api-reference/assets/delete-asset.md): Permanently delete an asset. - [Export a single asset to MJCF/USD/SDF](https://docs.gizmo.antimlabs.com/api-reference/assets/export-a-single-asset-to-mjcfusdsdf.md): Fetch one asset's full record from storage, build a single-asset document (geometry + joints + materials preserved), and run the export. Returns a ZIP archive (`application/zip`). GLB is not offered here — it requires a live render; use the editor for GLB. - [Generate an asset](https://docs.gizmo.antimlabs.com/api-reference/assets/generate-an-asset.md): Generate a single 3D asset from a text prompt. The asset includes geometry, joints, materials, physics properties, and affordances. - [Get asset detail](https://docs.gizmo.antimlabs.com/api-reference/assets/get-asset-detail.md): Retrieve a single asset by ID. Use `include_record=true` to get the full geometry, joints, and materials data. - [List assets](https://docs.gizmo.antimlabs.com/api-reference/assets/list-assets.md): Retrieve all assets belonging to the authenticated user. Optionally filter by scene. - [Browse premade catalog](https://docs.gizmo.antimlabs.com/api-reference/catalog/browse-premade-catalog.md): Search and browse the premade asset library. Supports full-text search across names and tags, category filtering, and pagination. - [Catalog categories](https://docs.gizmo.antimlabs.com/api-reference/catalog/catalog-categories.md): Get all available categories in the premade catalog. - [Catalog item detail](https://docs.gizmo.antimlabs.com/api-reference/catalog/catalog-item-detail.md): Get full details for a premade catalog item including download paths for GLB and USDZ files. - [Export scene to MJCF/USD/SDF](https://docs.gizmo.antimlabs.com/api-reference/export-scene-to-mjcfusdsdf.md): Fetch the scene graph from S3 and run the export via the Node.js bundle. - [Cancel a job](https://docs.gizmo.antimlabs.com/api-reference/jobs/cancel-a-job.md): Request cancellation of a running job. If the job has already completed, this is a no-op. - [Get job status](https://docs.gizmo.antimlabs.com/api-reference/jobs/get-job-status.md): Poll the current status of a generation job. Returns the job's status, timing, and optionally the full result payload once complete. - [Job event stream (SSE)](https://docs.gizmo.antimlabs.com/api-reference/jobs/job-event-stream-sse.md): Real-time Server-Sent Events stream of generation progress. Events include pipeline stage transitions, asset completion notifications, and error reports. - [Delete scene](https://docs.gizmo.antimlabs.com/api-reference/scenes/delete-scene.md): Permanently delete a scene and its associated data. - [Edit a scene](https://docs.gizmo.antimlabs.com/api-reference/scenes/edit-a-scene.md): Apply a natural language edit to an existing scene. The AI agent interprets your instruction and modifies the scene graph accordingly. - [Generate a scene](https://docs.gizmo.antimlabs.com/api-reference/scenes/generate-a-scene.md): Start async scene generation from a text prompt. Returns immediately with a `job_id`. - [Get scene detail](https://docs.gizmo.antimlabs.com/api-reference/scenes/get-scene-detail.md): Retrieve a single scene by ID, optionally including the full scene graph (3D geometry, joints, materials) from S3. - [List scenes](https://docs.gizmo.antimlabs.com/api-reference/scenes/list-scenes.md): Retrieve all scenes belonging to the authenticated user, ordered by creation date (newest first). - [Scene pipeline status](https://docs.gizmo.antimlabs.com/api-reference/scenes/scene-pipeline-status.md): Get detailed pipeline execution status for a scene — stages completed, errors, timing. - [Update scene metadata](https://docs.gizmo.antimlabs.com/api-reference/scenes/update-scene-metadata.md): Update a scene's name or description. Does not trigger regeneration. - [Core Idea](https://docs.gizmo.antimlabs.com/core-idea.md): How Gizmo transforms text prompts into simulation-ready 3D scenes - [Editor Walkthrough](https://docs.gizmo.antimlabs.com/editor-walkthrough.md): A complete guide to the Gizmo editor. Generate an asset from a prompt, build and edit a scene by hand, tune physics and robotics settings, then export to your simulator. - [Export Behavior](https://docs.gizmo.antimlabs.com/export-behavior.md): How Gizmo exports to USD, MJCF, SDF, and GLB for different simulators - [First Workflow](https://docs.gizmo.antimlabs.com/first-workflow.md): Step-by-step guide to generating, previewing, and exporting your first asset - [Getting Started](https://docs.gizmo.antimlabs.com/getting-started.md): How to start using Gizmo — browser editor and API access - [What is Gizmo?](https://docs.gizmo.antimlabs.com/index.md): AI-powered 3D simulation authoring for robotics — generate physics-ready scenes and assets from text prompts or reference images - [Joints and Physics](https://docs.gizmo.antimlabs.com/joints-and-physics.md): Joint types, axis conventions, and physics metadata in Gizmo - [Practical Notes](https://docs.gizmo.antimlabs.com/practical-notes.md): Important practical considerations when using Gizmo - [Quality Checklist](https://docs.gizmo.antimlabs.com/quality-checklist.md): Checklist for evaluating generated assets and scenes - [Starter Prompts](https://docs.gizmo.antimlabs.com/starter-prompts.md): Recommended prompts for quick testing across furniture, appliances, lab equipment, and scenes - [Troubleshooting](https://docs.gizmo.antimlabs.com/troubleshooting.md): Common issues and how to resolve them ## OpenAPI Specs - [openapi](https://docs.gizmo.antimlabs.com/openapi.json)