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

# List built-in sandbox images

> Lists the built-in images you can create a sandbox from.

Built-in images are the same for every team, so the request doesn't select a
team. Pass an image's `image` value directly as a sandbox's image, without
building or pushing it.

Related guide: [Choose a built-in image](/sandboxes/manage-images#choose-a-built-in-image).


## OpenAPI

````yaml get /v1/sandboxes/library_images
openapi: 3.1.0
info:
  description: REST API for management of Baseten resources
  title: Baseten management API
  version: 1.0.0
servers:
  - url: https://api.baseten.co
security:
  - BearerAuth: []
paths:
  /v1/sandboxes/library_images:
    get:
      tags:
        - Images
      summary: List built-in sandbox images
      description: >-
        Return the built-in sandbox images, the same for every team, so no team
        is selected. Use the image field directly as the image of a sandbox,
        without building or pushing it. Hidden and upcoming images are excluded.
      operationId: ListSandboxLibraryImages
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSandboxLibraryImagesResponseV1'
              examples:
                complete:
                  $ref: '#/components/examples/SandboxLibraryImages'
        '401':
          $ref: '#/components/responses/SandboxError401'
        '403':
          $ref: '#/components/responses/SandboxError403'
        '429':
          $ref: '#/components/responses/SandboxError429'
        '500':
          $ref: '#/components/responses/SandboxError500'
components:
  schemas:
    ListSandboxLibraryImagesResponseV1:
      type: object
      description: Built-in sandbox images.
      properties:
        items:
          type: array
          description: Built-in images.
          items:
            $ref: '#/components/schemas/SandboxLibraryImageV1'
      required:
        - items
    SandboxLibraryImageV1:
      type: object
      description: Built-in sandbox image usable directly as a sandbox image.
      properties:
        name:
          type: string
          description: Stable identifier of the built-in image.
          example: base-image
        display_name:
          type: string
          description: Human-readable name.
          example: Base Image
        description:
          type: string
          description: Short description.
          example: A minimal sandbox environment with the sandbox execution API.
        long_description:
          type: string
          description: Detailed description.
        image:
          type: string
          description: Image reference including its tag, usable as the image of a sandbox.
          example: baseten/base-image:latest
        memory:
          type: integer
          description: Recommended memory allocation in megabytes.
          example: 4096
        ports:
          $ref: '#/components/schemas/SandboxPortsV1'
        categories:
          type: array
          description: Categories of the image.
          items:
            type: string
        tags:
          type: array
          description: Tags of the image.
          items:
            type: string
        url:
          type: string
          description: Documentation URL.
        icon:
          type: string
          description: Icon URL.
        icon_light:
          type: string
          description: Light-mode icon URL.
        icon_dark:
          type: string
          description: Dark-mode icon URL.
        enterprise:
          type: boolean
          description: Whether the image requires an enterprise plan.
          example: false
        hidden:
          type: boolean
          description: Whether the image is hidden. Always false in listings.
          example: false
        coming_soon:
          type: boolean
          description: Whether the image is not yet available. Always false in listings.
          example: false
        creation_options:
          $ref: '#/components/schemas/SandboxLibraryImageCreationOptionsV1'
      required:
        - name
        - image
    SandboxPortsV1:
      type: array
      description: Set of ports for a resource
      items:
        $ref: '#/components/schemas/SandboxPortV1'
      example:
        - name: http
          protocol: HTTP
          target: 3000
    SandboxLibraryImageCreationOptionsV1:
      type: object
      description: Optional settings suggested when creating a sandbox from this image.
      properties:
        extra_args:
          type: object
          description: Kernel selection arguments.
          additionalProperties:
            type: string
        volumes:
          type: array
          description: Volume attachments.
          items:
            $ref: '#/components/schemas/SandboxLibraryImageVolumeV1'
    SandboxPortV1:
      type: object
      description: A port for a resource
      properties:
        name:
          type: string
          description: The name of the port
          example: http
        protocol:
          type: string
          description: The protocol of the port
          enum:
            - HTTP
            - TCP
            - UDP
            - TLS
          example: HTTP
        target:
          type: integer
          description: The target port of the port
          example: 3000
          minimum: 1
          maximum: 65535
      required:
        - target
      example:
        name: http
        protocol: HTTP
        target: 3000
    SandboxLibraryImageVolumeV1:
      type: object
      description: Volume attachment suggested by a built-in image.
      properties:
        name:
          type: string
          description: Volume name, or an internal identifier for ephemeral volumes.
          example: scratch
        mount_path:
          type: string
          description: Absolute filesystem path where the volume is mounted.
          example: /mnt/data
        type:
          type: string
          description: Volume type, persistent when empty.
          example: ephemeral
        size_mb:
          type: integer
          description: Storage capacity in megabytes for ephemeral volumes.
          example: 10240
        read_only:
          type: boolean
          description: Whether the volume is mounted read-only.
          example: false
      required:
        - name
        - mount_path
  examples:
    SandboxLibraryImages:
      summary: Built-in sandbox images
      value:
        items:
          - name: base-image
            display_name: Base Image
            description: A minimal sandbox environment with the sandbox execution API.
            long_description: ''
            image: baseten/base-image:latest
            memory: 4096
            ports:
              - name: sandbox-api
                protocol: HTTP
                target: 8080
            categories: []
            tags: []
            url: ''
            icon: https://example.com/base-image.png
            icon_light: https://example.com/base-image.png
            icon_dark: https://example.com/base-image.png
            enterprise: false
            hidden: false
            coming_soon: false
  responses:
    SandboxError401:
      description: >-
        Missing or invalid authentication. Returns a JSON error with code,
        message, and optional details.
      content:
        application/json:
          example:
            code: UNAUTHORIZED
            message: Provide a valid authentication token in the Authorization header.
            details:
              header: Authorization
    SandboxError403:
      description: >-
        Insufficient permissions. Returns a JSON error with code, message, and
        optional details.
      content:
        application/json:
          example:
            code: FORBIDDEN
            message: >-
              This authentication token does not grant permission to perform
              this operation.
            details:
              request_id: a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043
    SandboxError429:
      description: >-
        Request limit exceeded. Returns a JSON error with code, message, and
        optional details.
      content:
        application/json:
          example:
            code: RATE_LIMITED
            message: Too many requests. Try again in 30 seconds.
            details:
              retry_after_seconds: 30
    SandboxError500:
      description: >-
        Internal server error. Returns a JSON error with code, message, and
        optional details.
      content:
        application/json:
          example:
            code: INTERNAL_ERROR
            message: The request could not be completed. Try again later.
            details:
              request_id: a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send `Authorization: Bearer <api_key>`. The legacy `Authorization:
        Api-Key <api_key>` scheme is also accepted.

````