Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Register a space by providing the path to a directory containing a workspace.yml file.
workspace.yml
cURL
curl -X POST http://localhost:18080/api/workspaces/add \ -H 'Content-Type: application/json' \ -d '{"path": "/path/to/my-space"}'
const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: JSON.stringify({path: '/data/spaces/my-space', name: '<string>', description: '<string>'}) }; fetch('http://localhost:18080/api/workspaces/add', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));
import requests url = "http://localhost:18080/api/workspaces/add" payload = { "path": "/data/spaces/my-space", "name": "<string>", "description": "<string>" } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.text)
package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "http://localhost:18080/api/workspaces/add" payload := strings.NewReader("{\n \"path\": \"/data/spaces/my-space\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) }
{ "id": "abc123", "name": "my-space", "status": "active", "path": "<string>", "createdAt": "2023-11-07T05:31:56Z", "created": true }
Absolute path to the space directory containing workspace.yml
"/data/spaces/my-space"
Optional display name override
Optional description override
Space registered
"abc123"
"my-space"
"active"