Create a space

POST

api

workspaces

create

cURL

curl -X POST http://localhost:18080/api/workspaces/create \
  -H 'Content-Type: application/json' \
  -d '{
    "config": {
      "version": "1.0",
      "workspace": {
        "name": "my-space",
        "description": "A new space"
      }
    }
  }'

{
  "success": true,
  "workspace": {
    "id": "abc123",
    "name": "my-space",
    "description": "My first space",
    "status": "active",
    "path": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "lastSeen": "2023-11-07T05:31:56Z"
  },
  "created": true,
  "workspacePath": "<string>",
  "filesCreated": [
    "<string>"
  ]
}

Body

application/json

config

object

required

Full workspace configuration (workspace.yml content as JSON)

workspaceName

string

Optional directory name

ephemeral

boolean

default:false

Create as ephemeral (temporary) space

Response

200 - application/json

Space created

success

boolean

workspace

object

Show child attributes

created

boolean

workspacePath

string

filesCreated

string[]

Get space detailsGet a space's details and configuration.

⌘I

cURL

curl -X POST http://localhost:18080/api/workspaces/create \
  -H 'Content-Type: application/json' \
  -d '{
    "config": {
      "version": "1.0",
      "workspace": {
        "name": "my-space",
        "description": "A new space"
      }
    }
  }'

{
  "success": true,
  "workspace": {
    "id": "abc123",
    "name": "my-space",
    "description": "My first space",
    "status": "active",
    "path": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "lastSeen": "2023-11-07T05:31:56Z"
  },
  "created": true,
  "workspacePath": "<string>",
  "filesCreated": [
    "<string>"
  ]
}