Update a workspace

curl --request PATCH \
  --url https://api.lighton.ai/api/v3/workspaces/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "members": "<unknown>"
}
'

{
  "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>"
    }
  ]
}

Workspaces

Update a workspace

⚠️ ALPHA ENDPOINT - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.

Partially update a given workspace.

Standard update (workspace OWNER only):

name (string, optional): Desired workspace name (max 100 characters, cannot be empty)
description (string, optional): Desired workspace description. Send empty string or null to clear.

Convert to a synced workspace (workspace OWNER or a role granting workspace edit/delete):

datasource (object): Datasource configuration used to populate the workspace. Credentials are validated against the external source before persistence; use POST /api/v3/workspaces/{id}/datasource/test to validate them without committing.
The target workspace must be empty (no documents) and not already synced.

Edit an existing synced workspace’s datasource:

If the workspace is already synced and no successful sync has happened yet, sending a datasource payload edits the datasource in place (full credential re-entry required, name/filter_criteria updated, next sync re-triggered).
After the first successful sync, the field is rejected with 409 Conflict — ingested data integrity is preserved by locking the config. Delete and recreate the workspace to change its configuration.
The datasource type is immutable on edit (changing it returns 400).
Edits are also rejected with 409 while a sync is currently in flight (WAITING/PROCESSING).
The current edit-availability is exposed in the response under sync.editable (boolean).

Restrictions:

Only SHARED workspaces can be updated (PERSONAL workspaces cannot be modified)
Conversion is one-way: a synced workspace cannot be reverted to manual via the API

PATCH

api

workspaces

{id}

Update a workspace

curl --request PATCH \
  --url https://api.lighton.ai/api/v3/workspaces/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "members": "<unknown>"
}
'

{
  "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.

Path Parameters

integer

required

The unique identifier of the workspace.

Body

name

string

Workspace name (max 100 characters, cannot be empty).

description

string

Workspace description. Send empty string or null to clear.

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. REPLACES all existing members.

datasource

object

Datasource configuration to convert this workspace into a read-only synced workspace. Workspace OWNER (or a role granting workspace edit/delete) only. Cannot be undone.

Show child attributes

Response

Workspace updated successfully

V3 Response serializer for company workspace creation and retrieval.

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

Show child attributes

sync

object

required

Show child attributes

scoped_api_keys

object[]

required

read-only

Show child attributes

Retrieve a workspace Delete a workspace

⌘I