curl --request GET \
--url https://paradigm.lighton.ai/api/v3/workspaces/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://paradigm.lighton.ai/api/v3/workspaces/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://paradigm.lighton.ai/api/v3/workspaces/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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,
"user_role": "owner",
"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>",
"scope_type": "workspace"
}
]
}{
"id": null,
"code": 401,
"error": "unauthorized",
"detail": "Authentication credentials were not provided or are invalid.",
"doc_url": "https://developers.lighton.ai/errors#unauthorized"
}{
"id": null,
"code": 404,
"error": "not_found",
"detail": "The requested resource was not found.",
"doc_url": "https://developers.lighton.ai/errors#not_found"
}{
"id": null,
"code": 422,
"error": "validation_error",
"detail": "One or more fields failed validation.",
"doc_url": "https://developers.lighton.ai/errors#validation_error",
"fields": {
"<field_name>": [
{
"error": "required",
"detail": "This field is required."
}
]
}
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Retrieve a workspace
⚠️ ALPHA ENDPOINT - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
Retrieve a workspace by ID. Returns workspace in V3 format.
Access: Instance-level users (Sys Admin, Account Manager, Admin, DPO Admin) can retrieve any workspace. Company-level users (Company Admin, Company DPO) can retrieve workspaces in their company. Regular users can retrieve workspaces where they are members.
Member Visibility: Instance-level users and company-level users see all members. Workspace OWNER sees members. EDITOR and VIEWER do not see members.
Sync status: For synced workspaces, the response includes a sync block with datasource_type, source_name, last_status, updated_at, failed_files_count, and next_import_date. Use this field for polling the sync state.
Non-existent and unauthorized workspaces are treated identically (existence is not disclosed).
curl --request GET \
--url https://paradigm.lighton.ai/api/v3/workspaces/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://paradigm.lighton.ai/api/v3/workspaces/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://paradigm.lighton.ai/api/v3/workspaces/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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,
"user_role": "owner",
"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>",
"scope_type": "workspace"
}
]
}{
"id": null,
"code": 401,
"error": "unauthorized",
"detail": "Authentication credentials were not provided or are invalid.",
"doc_url": "https://developers.lighton.ai/errors#unauthorized"
}{
"id": null,
"code": 404,
"error": "not_found",
"detail": "The requested resource was not found.",
"doc_url": "https://developers.lighton.ai/errors#not_found"
}{
"id": null,
"code": 422,
"error": "validation_error",
"detail": "One or more fields failed validation.",
"doc_url": "https://developers.lighton.ai/errors#validation_error",
"fields": {
"<field_name>": [
{
"error": "required",
"detail": "This field is required."
}
]
}
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the workspace.
Response
Workspace details retrieved successfully
V3 Response serializer for company workspace creation and retrieval.
owner- ownereditor- editorviewer- viewer- `` -
owner, editor, viewer Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes