Skip to main content
POST
/
api
/
v3
/
workspaces
Create a workspace
curl --request POST \
  --url https://paradigm.lighton.ai/api/v3/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "workspace_type": "<string>",
  "document_upload_method": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "members": {
    "users": [
      123
    ],
    "groups": [
      123
    ]
  },
  "user_role": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

V3 API: Uses nested structure with members containing users and groups with roles

​
name
string
required
​
description
string
required
​
company_id
integer

Optional company ID. Only Sys Admin and Account Manager can create workspaces in other companies.

​
members
any

Members with roles in format {"users": [{"id": <user_id>, "role": "owner|editor|viewer"}, ...], "groups": [{"id": <group_id>, "role": "owner|editor|viewer"}, ...]}. Role defaults to viewer if not specified.

​
document_upload_method
enum<string>
default:manual

Method for adding documents to this workspace

  • manual - manual
  • synced - synced
Available options:
manual,
synced

Response

200 - application/json

V3 Response serializer for workspaces. Returns members in format: {"users": [<user_id1>, ...], "groups": [<group_id1>, ...]}

​
id
integer
required
​
name
string
required
​
workspace_type
string
required
​
document_upload_method
string
required
​
description
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
members
object
required
​
user_role
string
required