Create workspace
Creates a new workspace. The creator is automatically added as an owner.
curl --request POST \
--url https://api.example.com/workspaces/ \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"description": "<string>",
"settings": {
"ocr": "auto",
"requireApproval": true,
"retention": {
"auditLogs": {
"mode": "forever"
},
"originalDocuments": {
"mode": "forever"
},
"redactedDocuments": {
"mode": "forever"
}
}
},
"slug": "<string>"
}
'import requests
url = "https://api.example.com/workspaces/"
payload = {
"displayName": "<string>",
"description": "<string>",
"settings": {
"ocr": "auto",
"requireApproval": True,
"retention": {
"auditLogs": { "mode": "forever" },
"originalDocuments": { "mode": "forever" },
"redactedDocuments": { "mode": "forever" }
}
},
"slug": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
description: '<string>',
settings: {
ocr: 'auto',
requireApproval: true,
retention: {
auditLogs: {mode: 'forever'},
originalDocuments: {mode: 'forever'},
redactedDocuments: {mode: 'forever'}
}
},
slug: '<string>'
})
};
fetch('https://api.example.com/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/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([
'displayName' => '<string>',
'description' => '<string>',
'settings' => [
'ocr' => 'auto',
'requireApproval' => true,
'retention' => [
'auditLogs' => [
'mode' => 'forever'
],
'originalDocuments' => [
'mode' => 'forever'
],
'redactedDocuments' => [
'mode' => 'forever'
]
]
],
'slug' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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/workspaces/"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"ocr\": \"auto\",\n \"requireApproval\": true,\n \"retention\": {\n \"auditLogs\": {\n \"mode\": \"forever\"\n },\n \"originalDocuments\": {\n \"mode\": \"forever\"\n },\n \"redactedDocuments\": {\n \"mode\": \"forever\"\n }\n }\n },\n \"slug\": \"<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))
}HttpResponse<String> response = Unirest.post("https://api.example.com/workspaces/")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"ocr\": \"auto\",\n \"requireApproval\": true,\n \"retention\": {\n \"auditLogs\": {\n \"mode\": \"forever\"\n },\n \"originalDocuments\": {\n \"mode\": \"forever\"\n },\n \"redactedDocuments\": {\n \"mode\": \"forever\"\n }\n }\n },\n \"slug\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"ocr\": \"auto\",\n \"requireApproval\": true,\n \"retention\": {\n \"auditLogs\": {\n \"mode\": \"forever\"\n },\n \"originalDocuments\": {\n \"mode\": \"forever\"\n },\n \"redactedDocuments\": {\n \"mode\": \"forever\"\n }\n }\n },\n \"slug\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"displayName": "<string>",
"memberRole": "owner",
"settings": {
"ocr": "auto",
"requireApproval": true,
"retention": {
"auditLogs": {
"mode": "forever"
},
"originalDocuments": {
"mode": "forever"
},
"redactedDocuments": {
"mode": "forever"
}
}
},
"slug": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"avatarUrl": "<string>",
"description": "<string>"
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}"<string>""<string>"Body
Request payload for creating a new workspace.
Creates a new workspace with the specified configuration. The creator is automatically added as an owner of the workspace.
Request payload for creating a new workspace.
Creates a new workspace with the specified configuration. The creator is automatically added as an owner of the workspace.
Display name of the workspace (2-32 characters).
2 - 32Optional description of the workspace (max 500 characters).
500Workspace settings (approval requirement, data-retention rules). Defaults to requiring approval and keeping everything when omitted.
Show child attributes
Show child attributes
Optional URL slug. Derived from the display name when omitted.
3 - 32^[a-z0-9]+(?:-[a-z0-9]+)*$Response
Workspace response.
Workspace response.
Timestamp when the workspace was created.
Account that created this workspace.
Show child attributes
Show child attributes
Display name of the workspace.
Role of the member in the workspace.
"owner"Workspace settings (approval requirement, data-retention rules).
Show child attributes
Show child attributes
URL-safe workspace identifier.
3 - 32^[a-z0-9]+(?:-[a-z0-9]+)*$Timestamp when the workspace was last updated.
Serve path of the workspace's avatar (logo), when set.
Description of the workspace.
curl --request POST \
--url https://api.example.com/workspaces/ \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"description": "<string>",
"settings": {
"ocr": "auto",
"requireApproval": true,
"retention": {
"auditLogs": {
"mode": "forever"
},
"originalDocuments": {
"mode": "forever"
},
"redactedDocuments": {
"mode": "forever"
}
}
},
"slug": "<string>"
}
'import requests
url = "https://api.example.com/workspaces/"
payload = {
"displayName": "<string>",
"description": "<string>",
"settings": {
"ocr": "auto",
"requireApproval": True,
"retention": {
"auditLogs": { "mode": "forever" },
"originalDocuments": { "mode": "forever" },
"redactedDocuments": { "mode": "forever" }
}
},
"slug": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
description: '<string>',
settings: {
ocr: 'auto',
requireApproval: true,
retention: {
auditLogs: {mode: 'forever'},
originalDocuments: {mode: 'forever'},
redactedDocuments: {mode: 'forever'}
}
},
slug: '<string>'
})
};
fetch('https://api.example.com/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/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([
'displayName' => '<string>',
'description' => '<string>',
'settings' => [
'ocr' => 'auto',
'requireApproval' => true,
'retention' => [
'auditLogs' => [
'mode' => 'forever'
],
'originalDocuments' => [
'mode' => 'forever'
],
'redactedDocuments' => [
'mode' => 'forever'
]
]
],
'slug' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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/workspaces/"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"ocr\": \"auto\",\n \"requireApproval\": true,\n \"retention\": {\n \"auditLogs\": {\n \"mode\": \"forever\"\n },\n \"originalDocuments\": {\n \"mode\": \"forever\"\n },\n \"redactedDocuments\": {\n \"mode\": \"forever\"\n }\n }\n },\n \"slug\": \"<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))
}HttpResponse<String> response = Unirest.post("https://api.example.com/workspaces/")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"ocr\": \"auto\",\n \"requireApproval\": true,\n \"retention\": {\n \"auditLogs\": {\n \"mode\": \"forever\"\n },\n \"originalDocuments\": {\n \"mode\": \"forever\"\n },\n \"redactedDocuments\": {\n \"mode\": \"forever\"\n }\n }\n },\n \"slug\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"ocr\": \"auto\",\n \"requireApproval\": true,\n \"retention\": {\n \"auditLogs\": {\n \"mode\": \"forever\"\n },\n \"originalDocuments\": {\n \"mode\": \"forever\"\n },\n \"redactedDocuments\": {\n \"mode\": \"forever\"\n }\n }\n },\n \"slug\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"displayName": "<string>",
"memberRole": "owner",
"settings": {
"ocr": "auto",
"requireApproval": true,
"retention": {
"auditLogs": {
"mode": "forever"
},
"originalDocuments": {
"mode": "forever"
},
"redactedDocuments": {
"mode": "forever"
}
}
},
"slug": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"avatarUrl": "<string>",
"description": "<string>"
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}"<string>""<string>"