Sign in
Images

Get image

⚠️ This endpoint is in public preview.

Retrieve an image by ID. Returns both user-owned and public images.

get/preview/v2/images/{id}

Path parameters

idstring required

A resource path like 'sfc:image:acme:prod:my-image' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Example:image_k3R-nX9vLm7Qp2Yw5Jd8F

Image ID or resource path

Response

Image details

idstring required
resource_pathstring required

A resource path for a image resource. Format: sfc:image:<account>:<workspace>:<name>.

ownerstring required
workspacestring required
namestring required
object'image' required
upload_status'started' | 'uploading' | 'completed' | 'failed' | 'revoked' required
created_atinteger required

Unix timestamp.

providerstring nullable
sha256string nullable

Example response

{
  "id": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
  "resource_path": "sfc:image:<account_id>:<workspace>:<name>",
  "owner": "my-resource-name",
  "workspace": "my-resource-name",
  "name": "my-resource-name",
  "object": "image",
  "created_at": 1738972800
}

Changes

Changed in 2 of the 44 revisions of this API.11