Skip to main content
The Gizmo REST API gives you programmatic access to the same AI-powered 3D generation engine that drives gizmo.antimlabs.com. Use it to generate fully-articulated 3D assets from text prompts, poll their processing status, and export them in formats ready for NVIDIA Isaac Sim or MuJoCo — all from your own pipelines and tooling.
Early Access: The Gizmo API is in active development. Endpoints, request shapes, and response structures may change between releases. Subscribe to the changelog by emailing viswajit@antimlabs.com to receive breaking-change notices.

​
Base URL

All API requests are made over HTTPS to the following base URL: 
https://api.gizmo.antimlabs.com/v1
This base URL is illustrative for the alpha release and may be updated before general availability. You will receive the confirmed base URL when your API access is approved.
Every endpoint documented here is relative to this base URL. For example, the full URL for listing assets is: 
https://api.gizmo.antimlabs.com/v1/assets

​
Request Format

All request bodies must be JSON. Set the Content-Type header on every mutating request: 
Content-Type: application/json
Query parameters are used for filtering and pagination on list endpoints. Path parameters (e.g. {id}) identify specific resources.

​
Response Format

All responses are JSON and follow a consistent envelope structure. Successful responses return an HTTP 2xx status code and a JSON object containing the requested resource or action result directly at the top level: 
{
  "id": "ast_01hx9z3k2n8f7q",
  "status": "ready",
  "name": "Industrial Gripper",
  "created_at": "2024-11-12T09:41:00Z"
}
List responses wrap the resource array alongside pagination metadata: 
{
  "assets": [...],
  "total": 42,
  "limit": 20,
  "offset": 0
}

​
Error Format

Failed requests return a non-2xx HTTP status code and a JSON error body with the following fields:
FieldTypeDescription
errorstringShort machine-readable error category
codestringSpecific error code for programmatic handling
messagestringHuman-readable explanation of what went wrong
Example error response: 
{
  "error": "validation_error",
  "code": "MISSING_REQUIRED_FIELD",
  "message": "The 'prompt' field is required when generating a new asset."
}
Common HTTP status codes returned by the API:
StatusMeaning
200 OKRequest succeeded
201 CreatedResource was successfully created
400 Bad RequestInvalid request body or parameters
401 UnauthorizedMissing or invalid API key
403 ForbiddenAPI key does not have permission for this action
404 Not FoundThe requested resource does not exist
429 Too Many RequestsRate limit exceeded
500 Internal Server ErrorUnexpected server-side error

​
Rate Limits

During the alpha period, rate limits are applied per API key to ensure stability across all early-access users. Specific limits are communicated at the time of access approval and may be adjusted as the platform scales.
If your use case requires higher throughput, contact viswajit@antimlabs.com to discuss limit increases.
When a rate limit is exceeded, the API returns 429 Too Many Requests. Implement exponential backoff in your client before retrying.

​
Versioning

The API version is embedded in the base URL path (/v1). The current version is v1.
  • Non-breaking changes (new optional fields, new endpoints) are introduced without a version bump.
  • Breaking changes (removed fields, changed behavior, renamed endpoints) will be released under a new version prefix (e.g. /v2) with a deprecation notice and migration window.
Subscribe to breaking-change announcements by emailing viswajit@antimlabs.com.

​
Explore the API

Authentication

Obtain your API key and learn how to authenticate every request securely.

Assets

Generate 3D assets from text prompts, poll status, and export to Isaac Sim or MuJoCo.

Scenes

Compose multi-asset simulation environments and export them as complete scenes.