Skip to main content
POST
/
api
/
workspaces
/
add
cURL
curl -X POST http://localhost:18080/api/workspaces/add \
  -H 'Content-Type: application/json' \
  -d '{"path": "/path/to/my-space"}'
{
  "id": "abc123",
  "name": "my-space",
  "status": "active",
  "path": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "created": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.hellofriday.ai/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
path
string
required

Absolute path to the space directory containing workspace.yml

Example:

"/data/spaces/my-space"

​
name
string

Optional display name override

​
description
string

Optional description override

Response

200 - application/json

Space registered

​
id
string
Example:

"abc123"

​
name
string
Example:

"my-space"

​
status
string
Example:

"active"

​
path
string
​
createdAt
string<date-time>
​
created
boolean