Skip to main content
POST
/
preview
/
v2
/
workspaces
Create workspace
curl --request POST \
  --url https://api.sfcompute.com/preview/v2/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-resource-name"
}
'
{
  "id": "<string>",
  "resource_path": "<string>",
  "owner": "<string>",
  "name": "<string>",
  "object": "workspace",
  "created_at": 1738972800
}

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.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
null | string
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

Response

Workspace created.

​
id
string
required
Pattern: wksp_[0-9a-zA-Z_-]{1,21}
Example:

"wksp_k3R-nX9vLm7Qp2Yw5Jd8F"

​
resource_path
string
required

A resource path for a workspace resource. Format: sfc:workspace::.

Pattern: sfc:workspace:([a-zA-Z0-9._-]+:){1}[a-zA-Z0-9._-]+
Example:

"sfc:workspace:<account_id>:<name>"

​
owner
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
name
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
object
string
default:workspace
required
read-only
Allowed value: "workspace"
​
created_at
integer<int64>
required

Unix timestamp.

Example:

1738972800