Skip to main content
GET
/
preview
/
v2
/
images
List images
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/images \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "<string>",
      "owner": "<string>",
      "workspace": "<string>",
      "workspace_id": "<string>",
      "name": "<string>",
      "is_public": true,
      "object": "image",
      "created_at": 1738972800,
      "provider": "<string>",
      "sha256": "<string>"
    }
  ],
  "cursor": "imagec_gqXR7s0Kj5mHvE2wNpLc4Q"
}

Authorizations

​
Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Query Parameters

​
workspace
string
required

Filter by workspace. Pass sfc:workspace:sfcompute:public to list sfc-provided public images. 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.

Pattern: (wksp_[0-9a-zA-Z_-]{1,21})|(sfc:workspace:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){1,1})
Example:

"wksp_k3R-nX9vLm7Qp2Yw5Jd8F"

​
id
string[]

Filter by image ID (repeatable).

Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.

Pattern: image_[0-9a-zA-Z_-]{1,21}
Example:

"image_k3R-nX9vLm7Qp2Yw5Jd8F"

​
limit
integer<u-int32>
default:50

Maximum number of results to return (1-200, default 50).

Required range: 1 <= x <= 200
​
starting_after
string

Cursor for forward pagination (from a previous response's cursor field).

Pattern: ^imagec_[A-Za-z0-9_-]+$
Example:

"imagec_gqXR7s0Kj5mHvE2wNpLc4Q"

​
ending_before
string

Cursor for backward pagination.

Pattern: ^imagec_[A-Za-z0-9_-]+$
Example:

"imagec_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

Paginated list of images

​
object
string
default:list
required
read-only
Allowed value: "list"
​
has_more
boolean
required
​
data
object[]
required
​
cursor
null | string
Pattern: ^imagec_[A-Za-z0-9_-]+$
Example:

"imagec_gqXR7s0Kj5mHvE2wNpLc4Q"