Sign in

v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB
Images

Create image

⚠️ This endpoint is in public preview.

Create an image and start a multipart upload.

post/preview/v2/images

Request body

namestring
workspacestring required

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.

Example request

{
  "name": "my-resource-name",
  "workspace": "wksp_k3R-nX9vLm7Qp2Yw5Jd8F"
}

Response

Image created

resource_pathstring required

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

ownerstring required
workspacestring required
workspace_idstring required
namestring required
is_publicboolean required

Whether this is an sfc-provided public image.

object'image' required
upload_status'started' | 'uploading' | 'completed' | 'failed' | 'revoked' required
sha256string nullable
created_atinteger required

Unix timestamp.

Example response

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