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

# Edit asset collisions

> Team keys: edit existing collisions using natural language, preserving visual geometry and articulation; returns a new asset through the standard job endpoint.



## OpenAPI

````yaml /openapi.json post /v1/assets/{asset_id}/collision-edits
openapi: 3.1.0
info:
  title: Gizmo API
  description: >-
    Generate simulation-ready 3D assets from text and reference images,
    individually or in batches, and export them as USD / USDZ (Isaac Sim), MJCF
    (MuJoCo), SDF (Gazebo) or a GLB bundle with colliders and physics. Start
    with the [API quickstart](https://docs.gizmo.antimlabs.com/api-access) for
    complete workflows, or [hand Gizmo to your coding
    agent](https://docs.gizmo.antimlabs.com/use-with-your-agent).


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


    `POST /v1/assets` and `POST /v1/batches` return `202 Accepted` with a job or
    batch ID. Poll `GET /v1/jobs/{id}` or `GET /v1/batches/{id}` for progress;
    Personal keys can also stream `GET /v1/jobs/{id}/events` (SSE). Send an
    `Idempotency-Key` with every generation so a retried request never creates a
    duplicate job; Team keys must send one.


    ## Personal and Team keys


    One reference describes both key types; not every operation is available to
    both. Personal keys batch up to 50 items per batch. Team keys currently do
    not support SSE, GET /v1/usage or DELETE /v1/assets/{asset_id} (403
    workspace_route_unavailable; poll instead). Saved-file links, export-only
    retries, collision edits and scene reconstruction (POST /v1/scenes) are Team
    features when enabled for the Team.


    ## 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: Assets
    description: Generate individual assets and browse your Personal or Team library.
  - name: Scenes
    description: >-
      **Team plan only.** Reconstruct complete scenes from text or inline
      reference images, track delivery, and download scene files. All scene
      routes require a Team API key; Personal keys are not supported.
  - name: Batches
    description: >-
      Generate many assets in one request, with partial results and automatic
      queueing.
  - name: Images
    description: Upload and retrieve private original reference images.
  - name: Jobs
    description: >-
      Track, cancel and recover generation jobs. Teams use polling; Personal
      keys also support SSE.
  - name: Exports
    description: >-
      Download simulator formats, visual GLBs and collision bundles. Saved-file
      routes require Team access.
  - name: Account
    description: >-
      Check your key's identity. Request usage statistics currently require
      Personal access.
paths:
  /v1/assets/{asset_id}/collision-edits:
    post:
      tags:
        - Assets
      summary: Edit asset collisions
      description: >-
        Team keys: edit existing collisions using natural language, preserving
        visual geometry and articulation; returns a new asset through the
        standard job endpoint.
      operationId: edit_asset_collisions_v1_assets__asset_id__collision_edits_post
      parameters:
        - name: asset_id
          in: path
          required: true
          schema:
            type: string
            title: Asset Id
        - name: idempotency-key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[A-Za-z0-9._:-]+$
            title: Idempotency-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollisionEditBody'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportRetryAccepted'
        '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:
    CollisionEditBody:
      properties:
        instruction:
          type: string
          maxLength: 20000
          minLength: 1
          title: Instruction
      additionalProperties: false
      type: object
      required:
        - instruction
      title: CollisionEditBody
    ExportRetryAccepted:
      properties:
        ok:
          type: boolean
          title: Ok
        job_id:
          type: string
          title: Job Id
      type: object
      required:
        - ok
        - job_id
      title: ExportRetryAccepted
    ApiErrorResponse:
      properties:
        detail:
          $ref: '#/components/schemas/ApiErrorPayload'
      type: object
      required:
        - detail
      title: ApiErrorResponse
    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: >-
        Select Personal or your Team in Gizmo, then create a key in API Access.
        The key selects your library and billing account.

````

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