Add Workspaces
curl --request POST \
--url https://api.example.com/api/workspaces \
--header 'Content-Type: application/json' \
--header 'X-Session-API-Key: <api-key>' \
--data '
{
"workspaces": [
{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"parentPath": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/workspaces"
payload = { "workspaces": [
{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"parentPath": "<string>"
}
] }
headers = {
"X-Session-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaces: [{id: '<string>', name: '<string>', path: '<string>', parentPath: '<string>'}]
})
};
fetch('https://api.example.com/api/workspaces', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/workspaces",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspaces' => [
[
'id' => '<string>',
'name' => '<string>',
'path' => '<string>',
'parentPath' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Session-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/workspaces"
payload := strings.NewReader("{\n \"workspaces\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"parentPath\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-API-Key", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/workspaces")
.header("X-Session-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaces\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"parentPath\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaces\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"parentPath\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"workspaceParents": [
{
"id": "<string>",
"name": "<string>",
"path": "<string>"
}
],
"workspaces": [
{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"parentPath": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Workspaces
Add Workspaces
Append workspaces to the saved list. Idempotent — dedupes by path.
POST
/
api
/
workspaces
Add Workspaces
curl --request POST \
--url https://api.example.com/api/workspaces \
--header 'Content-Type: application/json' \
--header 'X-Session-API-Key: <api-key>' \
--data '
{
"workspaces": [
{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"parentPath": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/workspaces"
payload = { "workspaces": [
{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"parentPath": "<string>"
}
] }
headers = {
"X-Session-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaces: [{id: '<string>', name: '<string>', path: '<string>', parentPath: '<string>'}]
})
};
fetch('https://api.example.com/api/workspaces', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/workspaces",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspaces' => [
[
'id' => '<string>',
'name' => '<string>',
'path' => '<string>',
'parentPath' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Session-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/workspaces"
payload := strings.NewReader("{\n \"workspaces\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"parentPath\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-API-Key", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/workspaces")
.header("X-Session-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaces\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"parentPath\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaces\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"parentPath\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"workspaceParents": [
{
"id": "<string>",
"name": "<string>",
"path": "<string>"
}
],
"workspaces": [
{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"parentPath": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Was this page helpful?