> ## Documentation Index > Fetch the complete documentation index at: https://docs.sfcompute.com/llms.txt > Use this file to discover all available pages before exploring further. # List images > > ⚠️ This endpoint is in [public preview](/preview/roadmap). List images in the specified workspace. Pass `sfc:workspace:sfcompute:public` as the workspace to list sfc-provided public images instead. ## OpenAPI ````yaml /preview/openapi.json get /preview/v2/images openapi: 3.1.0 info: title: sfc-api description: >- Public preview API - subject to change. See https://docs.sfcompute.com/preview/roadmap for details. version: 0.1.0 servers: - url: https://api.sfcompute.com security: - bearer_auth: [] tags: - name: Account description: The authenticated account and logged-in user. - name: Pools description: A bucket of owned compute balance over time. - name: Orders description: >- Place orders targeting a capacity to increase your reserved compute balance during some time period. - name: Instance Templates description: Reusable instance configuration. - name: Images description: Custom machine images for instances. - name: Roles description: TOML-based permission role definitions. - name: Grants description: Bind principals (users or tokens) to roles on a workspace. - name: Tokens description: Workspace-scoped API tokens. - name: Instances description: Spin up instances in a capacity to use your available compute. - name: Instance SKU Catalog description: Browse available instance SKU property definitions. - name: Procurements description: Market automations that maintain capacity by placing buy/sell orders. - name: Deployments description: Deployment automations that maintain a fleet of instances on a capacity. - name: Spot Deployments description: >- Spot deployment automations that buy capacity up to a maximum price and run instances on secured capacity. - name: Users description: Read-only access to users within the caller's organization. - name: Workspaces description: Resource containers scoped to an account. - name: Permissions description: Inspect what the caller is allowed to do. - name: Billing description: Billing profile, contacts, and auto top-up settings. - name: Orderbook description: >- Read-only orderbook visibility: bid/ask spread, depth of book, and historical fills, keyed on hardware requirements + delivery window. - name: Orders description: >- Estimate an order before placing it: filled price, fee, and operational notices. paths: /preview/v2/images: get: tags: - Images summary: List images description: >- > ⚠️ This endpoint is in [public preview](/preview/roadmap). List images in the specified workspace. Pass `sfc:workspace:sfcompute:public` as the workspace to list sfc-provided public images instead. operationId: list_images parameters: - name: workspace in: query description: >- Filter by workspace. Pass `sfc:workspace:sfcompute:public` to list sfc-provided public images. required: true schema: $ref: '#/components/schemas/ResourcePathOrId_WorkspaceId' - name: id in: query description: Filter by image ID (repeatable). required: false schema: type: array items: $ref: '#/components/schemas/ImageId' style: form explode: true - name: limit in: query description: Maximum number of results to return (1-200, default 50). required: false schema: type: integer format: u-int32 default: 50 maximum: 200 minimum: 1 - name: starting_after in: query description: >- Cursor for forward pagination (from a previous response's `cursor` field). required: false schema: $ref: '#/components/schemas/ImagesCursor' - name: ending_before in: query description: Cursor for backward pagination. required: false schema: $ref: '#/components/schemas/ImagesCursor' responses: '200': description: Paginated list of images content: application/json: schema: $ref: '#/components/schemas/ListImagesResponse' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/BadRequestError' '401': description: Unauthorized request content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' components: schemas: ResourcePathOrId_WorkspaceId: type: string description: >- A resource path like 'sfc:workspace:acme:my-workspace' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. examples: - wksp_k3R-nX9vLm7Qp2Yw5Jd8F pattern: >- (wksp_[0-9a-zA-Z_-]{1,21})|(sfc:workspace:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){1,1}) ImageId: oneOf: - type: string examples: - image_k3R-nX9vLm7Qp2Yw5Jd8F pattern: image_[0-9a-zA-Z_-]{1,21} - type: string description: Legacy alias prefix; accepted on read, never emitted on write. pattern: vmi_[0-9a-zA-Z_-]{1,21} description: >- Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form. ImagesCursor: type: string examples: - imagec_gqXR7s0Kj5mHvE2wNpLc4Q pattern: ^imagec_[A-Za-z0-9_-]+$ ListImagesResponse: type: object required: - object - has_more - data properties: object: type: string const: list default: list readOnly: true cursor: oneOf: - type: 'null' - $ref: '#/components/schemas/ImagesCursor' has_more: type: boolean data: type: array items: $ref: '#/components/schemas/ImageListEntry' BadRequestError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: invalid_request_error default: invalid_request_error readOnly: true message: type: string x-speakeasy-error-message: true details: type: array items: $ref: '#/components/schemas/ErrorDetail' UnauthorizedError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: authentication_error default: authentication_error readOnly: true message: type: string x-speakeasy-error-message: true ForbiddenError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: forbidden default: forbidden readOnly: true message: type: string x-speakeasy-error-message: true InternalServerError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: api_error default: api_error readOnly: true message: type: string x-speakeasy-error-message: true ImageListEntry: allOf: - $ref: '#/components/schemas/ImageScope' - type: object required: - object - upload_status - created_at properties: object: type: string const: image default: image readOnly: true upload_status: $ref: '#/components/schemas/ImageUploadStatus' created_at: $ref: '#/components/schemas/UnixEpoch' provider: type: - string - 'null' sha256: type: - string - 'null' maxLength: 64 minLength: 64 pattern: ^[a-f0-9]{64}$ ErrorDetail: type: object required: - code - message properties: field: type: - string - 'null' description: The field that caused the error (for validation errors) code: type: string description: Specific error code for this detail message: type: string description: Human-readable error message ImageScope: type: object required: - id - resource_path - owner - workspace - workspace_id - name - is_public properties: id: $ref: '#/components/schemas/ImageId' resource_path: $ref: '#/components/schemas/imageResourcePath_ImageId' owner: $ref: '#/components/schemas/Name' workspace: $ref: '#/components/schemas/Name' workspace_id: $ref: '#/components/schemas/WorkspaceId' description: The workspace that owns this image. name: $ref: '#/components/schemas/Name' is_public: type: boolean description: Whether this is an sfc-provided public image. ImageUploadStatus: type: string enum: - started - uploading - completed - failed - revoked UnixEpoch: type: integer format: int64 description: Unix timestamp. example: 1738972800 imageResourcePath_ImageId: type: string description: >- A resource path for a image resource. Format: sfc:image:::. examples: - sfc:image::: pattern: sfc:image:([a-zA-Z0-9._-]+:){2}[a-zA-Z0-9._-]+ Name: type: string examples: - my-resource-name maxLength: 255 minLength: 1 pattern: '[a-zA-Z0-9][a-zA-Z0-9._-]{0,254}' WorkspaceId: type: string examples: - wksp_k3R-nX9vLm7Qp2Yw5Jd8F pattern: wksp_[0-9a-zA-Z_-]{1,21} securitySchemes: bearer_auth: type: http scheme: bearer bearerFormat: JWT description: >- Create an API token using `sf tokens create` or at https://sfcompute.com/account/api-keys. ````