v1
latestOpenAPI 3.1.02026-07-263580186.3 KBWorkspaces
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/v3/workspaces/{id}
Path parameters
idinteger required
The unique identifier of the workspace.
Request body
Response
Workspace updated successfully