> ## 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.

# List batch items and per-item results



## OpenAPI

````yaml /openapi.json get /v1/batches/{batch_id}/items
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_<your-key>

    ```


    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}/items:
    get:
      tags:
        - Batches
      summary: List batch items and per-item results
      operationId: batch_items_v1_batches__batch_id__items_get
      parameters:
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
            title: Batch Id
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Cursor
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 50
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchItemsResponse'
        '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:
    BatchItemsResponse:
      properties:
        ok:
          type: boolean
          title: Ok
        items:
          items:
            $ref: '#/components/schemas/BatchItemStatus'
          type: array
          title: Items
        has_more:
          type: boolean
          title: Has More
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      type: object
      required:
        - ok
        - items
        - has_more
        - next_cursor
      title: BatchItemsResponse
    ApiErrorResponse:
      properties:
        detail:
          $ref: '#/components/schemas/ApiErrorPayload'
      type: object
      required:
        - detail
      title: ApiErrorResponse
    BatchItemStatus:
      properties:
        reserved_spend_cents:
          anyOf:
            - type: integer
            - type: 'null'
          title: Reserved Spend Cents
          description: >-
            Legacy customer credits held; zero for new usage-billed jobs, null
            when unavailable
        settled_spend_cents:
          anyOf:
            - type: integer
            - type: 'null'
          title: Settled Spend Cents
          description: >-
            Customer credits charged so far, not total provider infrastructure
            cost
        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
        artifact_status:
          type: string
          enum:
            - unavailable
            - not_published
            - published
          title: Artifact Status
          default: unavailable
        published_formats:
          items:
            type: string
          type: array
          title: Published Formats
        validation_status:
          type: string
          const: not_reported
          title: Validation Status
          default: not_reported
        asset_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Asset Id
        retry_of_job_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Retry Of Job Id
        retry_mode:
          anyOf:
            - type: string
              const: export
            - type: 'null'
          title: Retry Mode
        failure_stage:
          anyOf:
            - type: string
              enum:
                - parent
                - blender
                - export
            - type: 'null'
          title: Failure Stage
        id:
          type: string
          title: Id
        index:
          type: integer
          title: Index
        custom_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Custom Id
        status:
          type: string
          title: Status
        phase:
          type: string
          title: Phase
        mode:
          type: string
          title: Mode
        budget_cents:
          anyOf:
            - type: integer
            - type: 'null'
          title: Budget Cents
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        created_at:
          type: number
          title: Created At
        started_at:
          anyOf:
            - type: number
            - type: 'null'
          title: Started At
        completed_at:
          anyOf:
            - type: number
            - type: 'null'
          title: Completed At
        release_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Release Id
        result_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Result Url
      type: object
      required:
        - id
        - index
        - status
        - phase
        - mode
        - created_at
      title: BatchItemStatus
    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_<hex>
      description: API key created in Gizmo Settings → API Keys

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.