> ## Documentation Index > Fetch the complete documentation index at: https://docs.gizmo.antimlabs.com/llms.txt > Use this file to discover all available pages before exploring further. # Get batch progress ## OpenAPI ````yaml /openapi.json get /v1/batches/{batch_id} openapi: 3.1.0 info: title: Gizmo Asset API description: >- Generate and export individual 3D assets from text and reference images. Export assets to USD / USDZ, MJCF, SDF, and GLB. Available formats depend on the asset and its accepted release. A successful export is not simulator certification. ## Authentication All endpoints require an API key passed via the `Authorization` header: ``` Authorization: Bearer gzm_k1_ ``` Select Personal or your Team in Gizmo, then create a key in API Access. Both use https://api.gizmo.antimlabs.com; the key selects the library and billing account. A Team may be called workspace in response fields and error codes. ## Rate Limiting Rate limits are per-key. Rate-limited API-key responses include: - `X-RateLimit-Limit` — requests allowed per minute - `X-RateLimit-Remaining` — requests remaining in current window - `X-RateLimit-Reset` — Unix timestamp when the window resets ## Async Generation Asset generation is asynchronous. `POST /v1/assets` returns `202 Accepted` with a `job_id`. Use `GET /v1/jobs/{id}` to poll. Personal keys also support `GET /v1/jobs/{id}/events` for SSE streaming. Team keys currently do not support SSE, GET /v1/usage or DELETE /v1/assets/{asset_id}; those operations return 403 workspace_route_unavailable. Use polling for progress and Team Billing for the current balance. Batch generation, saved-file links and export-only retries require Team access. One shared API reference describes both key types; it does not imply every operation is available to both. Team generation requires Idempotency-Key. ## Errors Errors on public endpoints use `detail.error` with code, message, and status. Validation errors also include fields. Responses include X-Request-ID for support. ```json {"detail": {"error": {"code": "asset_not_found", "message": "Asset not found", "status": 404}}} ``` version: 1.0.0 servers: - url: https://api.gizmo.antimlabs.com description: Production security: - ApiKeyAuth: [] tags: - name: Batches description: >- Team-only, asynchronous generation of up to 1,000 assets, with durable progress and partial results. - name: Images description: Upload and retrieve private original reference images. - name: Assets description: >- Manage individual 3D assets (articulated objects, furniture, equipment). Generate from a prompt and optional reference images, then retrieve or export the result. - name: Jobs description: >- Monitor and control async generation jobs. Poll with `GET /v1/jobs/{id}`, stream Personal job progress via `GET /v1/jobs/{id}/events` (SSE), or cancel with `POST /v1/jobs/{id}/cancel`. - name: Account description: View your identity and API usage statistics. paths: /v1/batches/{batch_id}: get: tags: - Batches summary: Get batch progress operationId: get_batch_v1_batches__batch_id__get parameters: - name: batch_id in: path required: true schema: type: string title: Batch Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BatchResponse' '401': content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' description: Not Found '409': content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' description: Unprocessable Entity '429': content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' description: Too Many Requests '503': content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' description: Service Unavailable components: schemas: BatchResponse: properties: ok: type: boolean title: Ok batch: $ref: '#/components/schemas/BatchResource' type: object required: - ok - batch title: BatchResponse ApiErrorResponse: properties: detail: $ref: '#/components/schemas/ApiErrorPayload' type: object required: - detail title: ApiErrorResponse BatchResource: properties: id: type: string title: Id max_concurrency: anyOf: - type: integer - type: 'null' title: Max Concurrency effective_max_concurrency: anyOf: - type: integer - type: 'null' title: Effective Max Concurrency description: >- Current configured ceiling, not available slots or guaranteed throughput admission_enabled: anyOf: - type: boolean - type: 'null' title: Admission Enabled max_cost_cents: anyOf: - type: integer - type: 'null' title: Max Cost Cents reserved_spend_cents: anyOf: - type: integer - type: 'null' title: Reserved Spend Cents description: Legacy held credits; zero for new usage-billed jobs settled_spend_cents: anyOf: - type: integer - type: 'null' title: Settled Spend Cents description: >- Customer credits charged so far; excludes internal provider infrastructure costs unresolved_provider_calls: anyOf: - type: integer - type: 'null' title: Unresolved Provider Calls billing_status: type: string enum: - unavailable - pending - reconciliation_required - complete title: Billing Status default: unavailable items_url: type: string title: Items Url source_batch_id: anyOf: - type: string - type: 'null' title: Source Batch Id status: type: string title: Status total_items: type: integer title: Total Items ingested_items: type: integer title: Ingested Items completed_items: type: integer title: Completed Items succeeded_items: type: integer title: Succeeded Items failed_items: type: integer title: Failed Items cancelled_items: type: integer title: Cancelled Items unsubmitted_items: type: integer title: Unsubmitted Items release_id: type: string title: Release Id created_at: type: number title: Created At updated_at: type: number title: Updated At error: anyOf: - type: string - type: 'null' title: Error type: object required: - id - items_url - status - total_items - ingested_items - completed_items - succeeded_items - failed_items - cancelled_items - unsubmitted_items - release_id - created_at - updated_at title: BatchResource ApiErrorPayload: properties: error: $ref: '#/components/schemas/ApiErrorDetail' type: object required: - error title: ApiErrorPayload ApiErrorDetail: properties: code: type: string title: Code description: Machine-readable error code examples: - asset_not_found message: type: string title: Message description: Human-readable description examples: - Asset ast_abc123 not found fields: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Fields status: type: integer title: Status description: HTTP status code examples: - 404 type: object required: - code - message - status title: ApiErrorDetail securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: gzm_k1_ description: API key created in Gizmo Settings → API Keys ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.