Browse datasource folders

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

import requests

url = "https://api.lighton.ai/api/v3/workspaces/datasource/browse"

payload = {
    "credentials": {},
    "drive_id": "<string>",
    "parent_id": "<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({credentials: {}, drive_id: '<string>', parent_id: '<string>'})
};

fetch('https://api.lighton.ai/api/v3/workspaces/datasource/browse', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lighton.ai/api/v3/workspaces/datasource/browse",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'credentials' => [
        
    ],
    'drive_id' => '<string>',
    'parent_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lighton.ai/api/v3/workspaces/datasource/browse"

	payload := strings.NewReader("{\n  \"credentials\": {},\n  \"drive_id\": \"<string>\",\n  \"parent_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lighton.ai/api/v3/workspaces/datasource/browse")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"credentials\": {},\n  \"drive_id\": \"<string>\",\n  \"parent_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lighton.ai/api/v3/workspaces/datasource/browse")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"credentials\": {},\n  \"drive_id\": \"<string>\",\n  \"parent_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "folders": [
    {
      "id": "b!abc",
      "name": "Documents",
      "has_children": true,
      "path": "Documents",
      "drive_id": null,
      "kind": "library"
    },
    {
      "id": "b!def",
      "name": "SyncedWithParadigm",
      "has_children": true,
      "path": "SyncedWithParadigm",
      "drive_id": null,
      "kind": "library"
    }
  ]
}

Workspaces

Browse datasource folders

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

Browse the remote folder hierarchy of a datasource without persisting anything.

Connects to the external provider using the credentials in the payload and returns the immediate subfolders of parent_id (or the top-level entries when parent_id is null). Use this to power a visual folder picker before submitting a datasource configuration via PATCH /api/v3/workspaces/{id} with a datasource payload.

Access: any authenticated user.

Supported providers and credentials:

googledrive: service_account_file (JSON string of the service account key file). When parent_id is omitted, returns the folders explicitly shared with the service account.
sharepoint: client_id, client_secret, tenant_id, instance_url, site_name. When both drive_id and parent_id are null, returns the site’s document libraries as kind="library" entries (each entry’s id is the drive id). Pass that id back as drive_id (with parent_id=null) to list the library root; pass it as drive_id together with a folder’s id as parent_id to descend into a folder.

POST

api

workspaces

datasource

browse

Browse datasource folders

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

import requests

url = "https://api.lighton.ai/api/v3/workspaces/datasource/browse"

payload = {
    "credentials": {},
    "drive_id": "<string>",
    "parent_id": "<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({credentials: {}, drive_id: '<string>', parent_id: '<string>'})
};

fetch('https://api.lighton.ai/api/v3/workspaces/datasource/browse', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lighton.ai/api/v3/workspaces/datasource/browse",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'credentials' => [
        
    ],
    'drive_id' => '<string>',
    'parent_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lighton.ai/api/v3/workspaces/datasource/browse"

	payload := strings.NewReader("{\n  \"credentials\": {},\n  \"drive_id\": \"<string>\",\n  \"parent_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lighton.ai/api/v3/workspaces/datasource/browse")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"credentials\": {},\n  \"drive_id\": \"<string>\",\n  \"parent_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lighton.ai/api/v3/workspaces/datasource/browse")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"credentials\": {},\n  \"drive_id\": \"<string>\",\n  \"parent_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "folders": [
    {
      "id": "b!abc",
      "name": "Documents",
      "has_children": true,
      "path": "Documents",
      "drive_id": null,
      "kind": "library"
    },
    {
      "id": "b!def",
      "name": "SyncedWithParadigm",
      "has_children": true,
      "path": "SyncedWithParadigm",
      "drive_id": null,
      "kind": "library"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

Pydantic request model for browsing the remote folder hierarchy of a datasource.

Only browsable providers (Google Drive, SharePoint) are accepted. Credentials are validated against the same models as the credential test endpoint.

type

enum<string>

required

Available options:

googledrive,

sharepoint

credentials

Credentials · object

drive_id

string | null

parent_id

string | null

Response

Folder listing

V3 Response serializer for the datasource folder browse endpoint.

folders

object[]

required

Show child attributes

Test datasource credentials Parse a document to Markdown

⌘I

Overview

Intelligence

Document Processing

Administration

Browse datasource folders

Authorizations

Body

Response