Skip to main content
POST
/
api
/
v3
/
workspaces
Create a workspace
curl --request POST \
  --url https://api.lighton.ai/api/v3/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": ""
}
'
{
  "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",
  "files_count": 123,
  "used_storage": 123,
  "summaries": [
    {
      "language": "<string>",
      "summary": "<string>"
    }
  ],
  "sync": {
    "datasource_type": "<string>",
    "source_name": "<string>",
    "last_status": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "failed_files_count": 123,
    "next_import_date": "2023-11-07T05:31:56Z",
    "editable": true,
    "name": "<string>",
    "instance_url": "<string>",
    "tenant_id": "<string>",
    "site_name": "<string>",
    "client_id": "<string>",
    "filter_criteria": "<unknown>"
  },
  "scoped_api_keys": [
    {
      "id": "<string>",
      "name": "<string>",
      "prefix": "<string>",
      "role": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

V3 Request serializer for creating a workspace in the user's company.

name
string
required
Maximum string length: 100
description
string
default:""

Response

Workspace created successfully

V3 Response serializer for company workspace creation and retrieval.

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
files_count
integer
required
user_role
required
  • owner - owner
  • editor - editor
  • viewer - viewer
  • `` -
Available options:
owner,
editor,
viewer
used_storage
number<double>
required
summaries
object[]
required
read-only
sync
object
required
scoped_api_keys
object[]
required
read-only