> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mint.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a reference image

> Get a reference image.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/reference-images/{referenceImageId}
openapi: 3.1.0
info:
  title: Mint Public API
  version: 0.2.0-alpha
  description: >-
    REST API for creating and managing account-owned 3D Models, Asset Packs,
    Worlds, Materials, Images, Audio, Animations, and their files.
  license:
    name: Proprietary
    url: https://docs.mint.gg/terms-of-service
servers:
  - url: https://api.mint.gg
    description: Production
  - url: https://api.dev.mint.gg
    description: Development
  - url: http://api.mint.localhost
    description: Local development
security: []
tags:
  - name: 3D Models
    description: >-
      Generate, read, revise, retry, optimize, retopologize, and convert 3D
      Models.
  - name: Asset Packs
    description: Generate and manage coordinated collections of 3D assets.
  - name: Worlds
    description: Generate, read, review, revise, and retry Worlds.
  - name: Materials
    description: Generate and read Materials and Material Packs.
  - name: Images
    description: Generate, edit, read, and upload reusable reference images.
  - name: Audio
    description: Generate and read Audio assets.
  - name: Animation
    description: Animate eligible assets and retrieve animation outputs.
  - name: Pricing
    description: Read-only advisory Credit estimates for public API operations.
  - name: Account
    description: Developer account, Credits, usage, and health.
  - name: Operations
    description: Poll asynchronous work and act on review-mode Previews.
  - name: Assets
    description: >-
      List account assets and retrieve their files, manifests, and download
      URLs.
paths:
  /v1/reference-images/{referenceImageId}:
    get:
      tags:
        - Images
      summary: Get a reference image
      description: Get a reference image.
      operationId: getReferenceImage
      parameters:
        - name: referenceImageId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Account-owned Mint asset.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryAsset'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerApiKey: []
components:
  schemas:
    LibraryAsset:
      type: object
      description: One account-owned asset from the Mint library.
      required:
        - object
        - type
        - id
      properties:
        object:
          const: asset
          description: Stable object discriminator.
        type:
          enum:
            - world
            - model
            - asset_pack
            - material
            - material_pack
            - image
            - audio
            - reference_image
          description: Mint asset type.
        id:
          type: string
          description: Mint asset ID.
        name:
          type:
            - string
            - 'null'
          description: Asset title shown in Mint.
        status:
          type:
            - string
            - 'null'
          description: Current asset status, when available.
        thumbnailUrl:
          type:
            - string
            - 'null'
          format: uri
          description: Asset thumbnail URL, when available.
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When the asset was created.
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When the asset last changed.
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackItem'
          description: Asset Pack or Material Pack items, when applicable.
      additionalProperties: true
    PackItem:
      type: object
      description: One publicly addressable item in an Asset Pack or Material Pack.
      required:
        - id
      properties:
        id:
          type: string
          description: Stable public pack item ID.
        index:
          type:
            - integer
            - 'null'
          description: Zero-based item position.
        displayName:
          type:
            - string
            - 'null'
          description: Item title shown in Mint.
        itemPrompt:
          type:
            - string
            - 'null'
          description: Prompt used for this item.
        status:
          type:
            - string
            - 'null'
          description: Current item status.
        previewImageUrl:
          type:
            - string
            - 'null'
          format: uri
          description: Item Preview image URL, when available.
        modelId:
          type:
            - string
            - 'null'
          description: Generated 3D Model ID, when applicable.
        materialId:
          type:
            - string
            - 'null'
          description: Generated Material ID, when applicable.
        errorMessage:
          type:
            - string
            - 'null'
          description: Safe item failure summary, when applicable.
      additionalProperties: true
    Problem:
      type: object
      description: RFC 9457-style API error response.
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri-reference
          enum:
            - https://api.mint.gg/problems/animation-actions-not-in-set
            - https://api.mint.gg/problems/animation-not-found
            - https://api.mint.gg/problems/animation-resource-unavailable
            - https://api.mint.gg/problems/animation-service-unavailable
            - https://api.mint.gg/problems/animation-set-not-found
            - https://api.mint.gg/problems/animation-start-failed
            - https://api.mint.gg/problems/artifact-not-found
            - https://api.mint.gg/problems/artifact-not-ready
            - https://api.mint.gg/problems/artifact-service-unavailable
            - https://api.mint.gg/problems/artifact-unavailable
            - https://api.mint.gg/problems/asset-deletion-unavailable
            - https://api.mint.gg/problems/asset-has-active-work
            - https://api.mint.gg/problems/asset-lookup-unavailable
            - https://api.mint.gg/problems/asset-not-found
            - https://api.mint.gg/problems/billing-required
            - https://api.mint.gg/problems/conversion-start-failed
            - https://api.mint.gg/problems/content-policy-blocked
            - https://api.mint.gg/problems/content-safety-unavailable
            - https://api.mint.gg/problems/developer-api-key-400
            - https://api.mint.gg/problems/developer-api-key-401
            - https://api.mint.gg/problems/developer-api-key-403
            - https://api.mint.gg/problems/developer-api-key-404
            - https://api.mint.gg/problems/developer-api-key-409
            - https://api.mint.gg/problems/downloads-disabled
            - https://api.mint.gg/problems/empty-reference-image
            - https://api.mint.gg/problems/generation-not-failed
            - https://api.mint.gg/problems/generation-not-retryable
            - https://api.mint.gg/problems/generation-start-failed
            - https://api.mint.gg/problems/idempotency-conflict
            - https://api.mint.gg/problems/idempotency-in-progress
            - https://api.mint.gg/problems/image-not-ready
            - https://api.mint.gg/problems/internal-server-error
            - https://api.mint.gg/problems/invalid-animation-id
            - https://api.mint.gg/problems/invalid-animation-target
            - https://api.mint.gg/problems/invalid-api-key
            - https://api.mint.gg/problems/invalid-artifact-action
            - https://api.mint.gg/problems/invalid-asset-id
            - https://api.mint.gg/problems/invalid-asset-type
            - https://api.mint.gg/problems/invalid-conversion-source
            - https://api.mint.gg/problems/invalid-idempotency-key
            - https://api.mint.gg/problems/invalid-item-count
            - https://api.mint.gg/problems/invalid-model-optimization-state
            - https://api.mint.gg/problems/invalid-operation-mode
            - https://api.mint.gg/problems/invalid-operation-stage
            - https://api.mint.gg/problems/invalid-pagination
            - https://api.mint.gg/problems/invalid-reference-image-data
            - https://api.mint.gg/problems/invalid-request
            - https://api.mint.gg/problems/invalid-source-image
            - https://api.mint.gg/problems/lifecycle-transition-failed
            - https://api.mint.gg/problems/manual-action-required
            - https://api.mint.gg/problems/method-not-allowed
            - https://api.mint.gg/problems/missing-generation-resource
            - https://api.mint.gg/problems/missing-item-ids
            - https://api.mint.gg/problems/model-already-optimized
            - https://api.mint.gg/problems/model-list-unavailable
            - https://api.mint.gg/problems/model-lookup-unavailable
            - https://api.mint.gg/problems/model-not-found
            - https://api.mint.gg/problems/model-optimization-in-progress
            - https://api.mint.gg/problems/model-optimization-start-failed
            - https://api.mint.gg/problems/operation-lookup-unavailable
            - https://api.mint.gg/problems/operation-not-found
            - https://api.mint.gg/problems/operation-reservation-failed
            - https://api.mint.gg/problems/operation-transition-failed
            - https://api.mint.gg/problems/prompt-revision-required
            - https://api.mint.gg/problems/pricing-estimate-unavailable
            - https://api.mint.gg/problems/rate-limited
            - https://api.mint.gg/problems/reference-image-fetch-failed
            - https://api.mint.gg/problems/reference-image-too-large
            - https://api.mint.gg/problems/reference-image-tracking-failed
            - https://api.mint.gg/problems/reference-image-upload-failed
            - https://api.mint.gg/problems/regeneration-start-failed
            - https://api.mint.gg/problems/retopology-start-failed
            - https://api.mint.gg/problems/retry-start-failed
            - https://api.mint.gg/problems/route-not-found
            - https://api.mint.gg/problems/unsupported-reference-image-type
            - https://api.mint.gg/problems/usage-unavailable
            - https://api.mint.gg/problems/world-list-unavailable
            - https://api.mint.gg/problems/world-lookup-unavailable
            - https://api.mint.gg/problems/world-not-found
          description: Stable URI identifying the error category.
        title:
          type: string
          description: Short error category title.
        status:
          type: integer
          description: HTTP status code for this error.
        detail:
          type: string
          description: Developer-readable explanation of this occurrence.
        instance:
          type: string
          format: uri-reference
          description: Request path or identifier for this occurrence.
        errors:
          type: array
          maxItems: 5
          description: >-
            Machine-readable field issues included for request validation
            failures.
          items:
            $ref: '#/components/schemas/ValidationIssue'
        operationId:
          type: string
          description: >-
            Blocked operation that can be polled and resumed after billing is
            resolved.
        billing:
          type: object
          additionalProperties: false
          description: The billing action required before this operation can continue.
          required:
            - reason
            - resource
            - stage
            - requiredCredits
            - actionUrl
          properties:
            reason:
              type: string
              enum:
                - subscription_required
                - past_due
                - quota_exhausted_upgrade_available
                - quota_exhausted_top_tier
                - insufficient_credits
                - insufficient_completion_credits
            resource:
              type: string
              enum:
                - preview
                - world
                - model
                - asset_pack
                - material
                - material_pack
                - image
                - audio
            stage:
              type: string
              enum:
                - preview
                - final
            requiredCredits:
              type: number
              minimum: 0
            availableCredits:
              type: number
              minimum: 0
            committedCredits:
              type: number
              minimum: 0
            stageCredits:
              type: number
              minimum: 0
            completionCredits:
              type: number
              minimum: 0
            ctaKind:
              type: string
              enum:
                - view_plans
                - upgrade_plan
                - buy_top_up_credits
            actionUrl:
              type: string
              format: uri
              description: >-
                Platform billing URL where the developer can add Credits or
                subscribe.
    ValidationIssue:
      type: object
      additionalProperties: false
      description: One invalid request field reported by Mint.
      required:
        - path
        - code
        - message
      properties:
        path:
          type: string
          description: >-
            Field path rooted at body, such as body.prompt or
            body.sourceImages[0].
        code:
          type: string
          enum:
            - custom
            - invalid_element
            - invalid_format
            - invalid_key
            - invalid_type
            - invalid_union
            - invalid_value
            - not_multiple_of
            - too_big
            - too_small
            - unrecognized_keys
          description: Stable validation category supplied by the request schema.
        message:
          type: string
          description: Developer-readable explanation for this field.
  headers:
    RequestId:
      schema:
        type: string
        format: uuid
      description: Mint request identifier to include when reporting a problem to support.
    RateLimitLimit:
      schema:
        type: integer
        minimum: 1
      description: Maximum requests allowed by the active rate-limit bucket.
    RateLimitRemaining:
      schema:
        type: integer
        minimum: 0
      description: Whole requests remaining in the active rate-limit bucket.
    RateLimitReset:
      schema:
        type: integer
        format: int64
      description: >-
        Unix timestamp in seconds when the continuously refilling bucket is
        expected to be full.
  responses:
    Unauthorized:
      description: Missing, malformed, inactive, or revoked API key.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
    NotFound:
      description: The requested API resource was not found.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
    TooManyRequests:
      description: >-
        An account or traffic-class token bucket was exhausted. Authenticated
        traffic allows 600 requests per minute; paid work and conversions each
        allow 30 starts per minute. Limits refill continuously and are shared
        across an account's API keys.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        Retry-After:
          schema:
            type: string
          description: Seconds to wait before retrying.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ServiceUnavailable:
      description: Mint could not reach the backend service.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      description: Mint API key sent as a Bearer token.

````