Test datasource credentials

curl --request POST \
  --url https://api.lighton.ai/api/v3/workspaces/datasource/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "credentials": {},
  "filter_criteria": {}
}
'

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

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. Returns 200 if the connection succeeds, 400 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

workspaces

datasource

test

Test datasource credentials

curl --request POST \
  --url https://api.lighton.ai/api/v3/workspaces/datasource/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "credentials": {},
  "filter_criteria": {}
}
'

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

Authorizations

Authorization

string

header

required

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

Body

Pydantic request model for datasource conversion and credential testing.

type

enum<string>

required

Available options:

googledrive,

sharepoint,

servicenow,

webscrapper

name

string

required

credentials

Credentials · object

filter_criteria

Filter Criteria · object

Response

Connection successful

Delete a workspace Parse a document to Markdown

⌘I