Test datasource credentials
curl --request POST \
--url https://paradigm.lighton.ai/api/v3/workspaces/datasource/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'import requests
url = "https://paradigm.lighton.ai/api/v3/workspaces/datasource/test"
payload = { "name": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://paradigm.lighton.ai/api/v3/workspaces/datasource/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"code": 123,
"error": "<string>",
"detail": "<string>",
"doc_url": "<string>"
}{
"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": 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>"
]
}Workspaces
Test datasource credentials
⚠️ ALPHA ENDPOINT - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
Test datasource credentials without persisting anything.
Validates that the provided credentials can connect to the external source. Succeeds when the connection can be established; returns an error otherwise. No datasource or import is created. Use this before PATCH /api/v3/workspaces/{id} with a datasource payload to surface connection errors before committing the conversion.
Access: any authenticated user.
Credentials per type:
- googledrive:
service_account_file(JSON string of the service account key file) - sharepoint:
client_id,client_secret,tenant_id,site_id(optional),site_name(optional) - servicenow:
instance_url,username,password - webscrapper: no credentials required
Filter criteria per type:
- googledrive:
folder_id(required),recursive(optional) - sharepoint:
folder_path(required),recursive(optional) - servicenow:
doc_type(required, e.g.knowledge) - webscrapper:
start_url(required)
POST
/
api
/
v3
/
workspaces
/
datasource
/
test
Test datasource credentials
curl --request POST \
--url https://paradigm.lighton.ai/api/v3/workspaces/datasource/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'import requests
url = "https://paradigm.lighton.ai/api/v3/workspaces/datasource/test"
payload = { "name": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://paradigm.lighton.ai/api/v3/workspaces/datasource/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"code": 123,
"error": "<string>",
"detail": "<string>",
"doc_url": "<string>"
}{
"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": 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.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
Connection successful