⚠️ 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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LightOn Developers","colors":{"primary":"#1f99bb","light":"#1f99bb","dark":"#1f99bb"},"logo":{"light":"https://mintcdn.com/lighton-developers/dojq_qF_vSGGGm4-/logo/light.svg?fit=max\u0026auto=format\u0026n=dojq_qF_vSGGGm4-\u0026q=85\u0026s=345d3b10124f99971a7737a9f06f2886","dark":"https://mintcdn.com/lighton-developers/dojq_qF_vSGGGm4-/logo/dark.svg?fit=max\u0026auto=format\u0026n=dojq_qF_vSGGGm4-\u0026q=85\u0026s=d1c2d4800c07667359bb3abf2437e7aa"},"favicon":"https://mintcdn.com/lighton-developers/p54dDELPycbNT9ym/favicon.svg?fit=max\u0026auto=format\u0026n=p54dDELPycbNT9ym\u0026q=85\u0026s=c9a4897b47f6d0e0d035509f82d5c847","navbar":{"primary":{"type":"button","label":"Console","href":"https://console.lighton.ai"}},"footer":{"socials":{"x":"https://x.com/lightonio","linkedin":"https://www.linkedin.com/company/lighton","bluesky":"https://bsky.app/profile/lightonai.bsky.social","youtube":"https://www.youtube.com/@lighton4013","website":"https://lighton.ai/newsletter"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Playground","icon":"circle-play","href":"https://console.lighton.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lighton-developers","hasAudioNarration":false,"actualSubdomain":"lighton-developers","customDomains":["developers.lighton.ai"],"gitSource":{"type":"github","owner":"lightonai","repo":"lighton-developers-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0d933663d8e17af01bd02","collectionId":"33d6668b-f92a-409f-9b5b-7f9039646113","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0d933663d8e17af01bd02"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae0d933663d8e17af01bd02","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":50},{"language":"default","tag":"Intelligence","count":30},{"language":"default","tag":"Tutorials","count":15},{"language":"default","tag":"Facets","count":14},{"language":"default","tag":"Administration","count":13},{"language":"default","tag":"MCP Server","count":9},{"language":"default","tag":"Integrations","count":8},{"language":"default","tag":"Classify and organise documents","count":8},{"language":"default","tag":"Workspaces","count":8},{"language":"default","tag":"Budget","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@lighton.ai"}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/workspaces/browse-datasource-folders","slug":"/api-reference/workspaces/browse-datasource-folders","pageMetadata":{"title":"Browse datasource folders","description":"⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.\n\nBrowse the remote folder hierarchy of a datasource without persisting anything.\n\nConnects 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.\n\n**Access:** any authenticated user.\n\nSupported providers and credentials:\n- **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.\n- **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.","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/workspaces/datasource/browse","href":"/api-reference/workspaces/browse-datasource-folders","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"⚠️ \", _jsx(_components.strong, {\n children: \"ALPHA ENDPOINT\"\n }), \" - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Browse the remote folder hierarchy of a datasource without persisting anything.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Connects to the external provider using the credentials in the payload and returns the immediate subfolders of \", _jsx(_components.code, {\n children: \"parent_id\"\n }), \" (or the top-level entries when \", _jsx(_components.code, {\n children: \"parent_id\"\n }), \" is \", _jsx(_components.code, {\n children: \"null\"\n }), \"). Use this to power a visual folder picker before submitting a datasource configuration via \", _jsx(_components.code, {\n children: \"PATCH /api/v3/workspaces/{id}\"\n }), \" with a \", _jsx(_components.code, {\n children: \"datasource\"\n }), \" payload.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Access:\"\n }), \" any authenticated user.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Supported providers and credentials:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"googledrive\"\n }), \": \", _jsx(_components.code, {\n children: \"service_account_file\"\n }), \" (JSON string of the service account key file). When \", _jsx(_components.code, {\n children: \"parent_id\"\n }), \" is omitted, returns the folders explicitly shared with the service account.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"sharepoint\"\n }), \": \", _jsx(_components.code, {\n children: \"client_id\"\n }), \", \", _jsx(_components.code, {\n children: \"client_secret\"\n }), \", \", _jsx(_components.code, {\n children: \"tenant_id\"\n }), \", \", _jsx(_components.code, {\n children: \"instance_url\"\n }), \", \", _jsx(_components.code, {\n children: \"site_name\"\n }), \". When both \", _jsx(_components.code, {\n children: \"drive_id\"\n }), \" and \", _jsx(_components.code, {\n children: \"parent_id\"\n }), \" are \", _jsx(_components.code, {\n children: \"null\"\n }), \", returns the site’s document libraries as \", _jsx(_components.code, {\n children: \"kind=\\\"library\\\"\"\n }), \" entries (each entry’s \", _jsx(_components.code, {\n children: \"id\"\n }), \" is the drive id). Pass that \", _jsx(_components.code, {\n children: \"id\"\n }), \" back as \", _jsx(_components.code, {\n children: \"drive_id\"\n }), \" (with \", _jsx(_components.code, {\n children: \"parent_id=null\"\n }), \") to list the library root; pass it as \", _jsx(_components.code, {\n children: \"drive_id\"\n }), \" together with a folder’s \", _jsx(_components.code, {\n children: \"id\"\n }), \" as \", _jsx(_components.code, {\n children: \"parent_id\"\n }), \" to descend into a folder.\"]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Browse datasource folders","description":"⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.\n\nBrowse the remote folder hierarchy of a datasource without persisting anything.\n\nConnects 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.\n\n**Access:** any authenticated user.\n\nSupported providers and credentials:\n- **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.\n- **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.","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/workspaces/datasource/browse","href":"/api-reference/workspaces/browse-datasource-folders","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"api_v3_workspaces_datasource_browse_create","description":"⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.\n\nBrowse the remote folder hierarchy of a datasource without persisting anything.\n\nConnects 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.\n\n**Access:** any authenticated user.\n\nSupported providers and credentials:\n- **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.\n- **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.","summary":"Browse datasource folders","tags":["Workspaces"],"requestBody":"c10cc0ad-ed87-42d0-a2a5-b032645df4e5","security":["fcc68fa4-a269-488d-9b45-98521d3b8f65"],"responses":{"200":"02bb39a0-028f-4361-9eed-bc6796d59481","400":"e3f1c987-bd24-45ff-9997-9452ff86aea7","401":"f4874578-18e9-44b2-8bcf-de25aab20085","422":"7399f3ab-de45-4f05-be70-84b341867b0c","503":"29ef30e5-5201-496f-8e67-e2215b060c1c"},"method":"post","type":"path","servers":["48c3fa0c-537e-4ab8-b62c-fc02ab11f431"],"path":"/api/v3/workspaces/datasource/browse","baseUrlOptions":["https://api.lighton.ai"],"title":"Browse datasource folders","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"description":"Pydantic request model for browsing the remote folder hierarchy of a datasource.\n\nOnly browsable providers (Google Drive, SharePoint) are accepted. Credentials are\nvalidated against the same models as the credential test endpoint.","properties":{"type":{"type":"string","title":"Type","enum":["googledrive","sharepoint"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"credentials":{"additionalProperties":true,"default":{},"title":"Credentials","type":"object","uniqueKey":"credentials","typeLabel":"Credentials · object"},"drive_id":{"oneOf":[{"type":"string","title":"Drive Id","uniqueKey":"drive_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Drive Id","uniqueKey":"drive_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"drive_id","typeLabel":"string | null"},"parent_id":{"oneOf":[{"type":"string","title":"Parent Id","uniqueKey":"parent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Id","uniqueKey":"parent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_id","typeLabel":"string | null"}},"required":["type"],"title":"WorkspaceDatasourceBrowseV3Request","type":"object","uniqueKey":"","typeLabel":"WorkspaceDatasourceBrowseV3Request · object"},"examples":{"SharePoint—ListDocumentLibraries(root)":{"title":"SharePoint—ListDocumentLibraries(root)","value":{"type":"sharepoint","credentials":{"tenant_id":"tenant-uuid","client_id":"client-uuid","client_secret":"secret","instance_url":"https://contoso.sharepoint.com","site_name":"Engineering"},"drive_id":null,"parent_id":null}},"SharePoint—ListFoldersInsideALibrary":{"title":"SharePoint—ListFoldersInsideALibrary","value":{"type":"sharepoint","credentials":{"tenant_id":"tenant-uuid","client_id":"client-uuid","client_secret":"secret","instance_url":"https://contoso.sharepoint.com","site_name":"Engineering"},"drive_id":"b!abc","parent_id":null}},"GoogleDrive—ChildrenOfAFolder":{"title":"GoogleDrive—ChildrenOfAFolder","value":{"type":"googledrive","credentials":{"service_account_file":"{\"type\":\"service_account\", \"...\": \"...\"}"},"parent_id":"0AAbCdEfGhIjKlMn"}}},"exampleType":"examples"},"application/x-www-form-urlencoded":{"schema":{"description":"Pydantic request model for browsing the remote folder hierarchy of a datasource.\n\nOnly browsable providers (Google Drive, SharePoint) are accepted. Credentials are\nvalidated against the same models as the credential test endpoint.","properties":{"type":{"type":"string","title":"Type","enum":["googledrive","sharepoint"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"credentials":{"additionalProperties":true,"default":{},"title":"Credentials","type":"object","uniqueKey":"credentials","typeLabel":"Credentials · object"},"drive_id":{"oneOf":[{"type":"string","title":"Drive Id","uniqueKey":"drive_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Drive Id","uniqueKey":"drive_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"drive_id","typeLabel":"string | null"},"parent_id":{"oneOf":[{"type":"string","title":"Parent Id","uniqueKey":"parent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Id","uniqueKey":"parent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_id","typeLabel":"string | null"}},"required":["type"],"title":"WorkspaceDatasourceBrowseV3Request","type":"object","uniqueKey":"","typeLabel":"WorkspaceDatasourceBrowseV3Request · object"},"examples":{"Example":{"title":"Example","value":{"credentials":{},"drive_id":"\u003cstring>","parent_id":"\u003cstring>"}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"description":"Pydantic request model for browsing the remote folder hierarchy of a datasource.\n\nOnly browsable providers (Google Drive, SharePoint) are accepted. Credentials are\nvalidated against the same models as the credential test endpoint.","properties":{"type":{"type":"string","title":"Type","enum":["googledrive","sharepoint"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"credentials":{"additionalProperties":true,"default":{},"title":"Credentials","type":"object","uniqueKey":"credentials","typeLabel":"Credentials · object"},"drive_id":{"oneOf":[{"type":"string","title":"Drive Id","uniqueKey":"drive_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Drive Id","uniqueKey":"drive_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"drive_id","typeLabel":"string | null"},"parent_id":{"oneOf":[{"type":"string","title":"Parent Id","uniqueKey":"parent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Id","uniqueKey":"parent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_id","typeLabel":"string | null"}},"required":["type"],"title":"WorkspaceDatasourceBrowseV3Request","type":"object","uniqueKey":"","typeLabel":"WorkspaceDatasourceBrowseV3Request · object"},"examples":{"Example":{"title":"Example","value":{"credentials":{},"drive_id":"\u003cstring>","parent_id":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"examples"},"responses":{"02bb39a0-028f-4361-9eed-bc6796d59481":{"content":{"application/json":{"schema":{"type":"object","description":"V3 Response serializer for the datasource folder browse endpoint.","properties":{"folders":{"type":"array","items":{"type":"object","description":"A single folder entry returned by the datasource browse endpoint.","properties":{"id":{"type":"string","description":"Provider folder identifier (SharePoint item id or Google Drive file id).","isRequired":true,"uniqueKey":"folders.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Folder display name.","isRequired":true,"uniqueKey":"folders.items.[INDEX].name","typeLabel":"string"},"has_children":{"type":"boolean","description":"Best-effort hint for the tree UI: True when the folder is known or assumed to contain subfolders.","isRequired":true,"uniqueKey":"folders.items.[INDEX].has_children","typeLabel":"boolean"},"path":{"oneOf":[{"type":"string","description":"Full path from the drive root (SharePoint only). Null for Google Drive.","uniqueKey":"folders.items.[INDEX].path.oneOf.0","typeLabel":"string"},{"type":"null","description":"Full path from the drive root (SharePoint only). Null for Google Drive.","uniqueKey":"folders.items.[INDEX].path.oneOf.1","typeLabel":"null"}],"uniqueKey":"folders.items.[INDEX].path","typeLabel":"string | null"},"drive_id":{"oneOf":[{"type":"string","description":"SharePoint drive containing the folder. Set for items returned inside a document library; null for library entries themselves and for Google Drive.","uniqueKey":"folders.items.[INDEX].drive_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"SharePoint drive containing the folder. Set for items returned inside a document library; null for library entries themselves and for Google Drive.","uniqueKey":"folders.items.[INDEX].drive_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"folders.items.[INDEX].drive_id","typeLabel":"string | null"},"kind":{"type":"string","description":"Item kind. SharePoint root returns 'library' entries (document libraries); everything else is 'folder'.\n\n* `library` - library\n* `folder` - folder","default":"folder","enum":["library","folder"],"uniqueKey":"folders.items.[INDEX].kind","typeLabel":"enum\u003cstring>"}},"required":["has_children","id","name"],"uniqueKey":"folders.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"folders","typeLabel":"object[]"}},"required":["folders"],"uniqueKey":"","typeLabel":"object"},"examples":{"Response—SharePointDocumentLibraries":{"title":"Response—SharePointDocumentLibraries","value":{"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"}]}},"Response—SharePointFoldersInsideALibrary":{"title":"Response—SharePointFoldersInsideALibrary","value":{"folders":[{"id":"01ABC","name":"Engineering","has_children":true,"path":"/Engineering","drive_id":"b!abc","kind":"folder"},{"id":"01DEF","name":"Templates","has_children":false,"path":"/Templates","drive_id":"b!abc","kind":"folder"}]}}},"exampleType":"examples"}},"description":"Folder listing","exampleType":"examples"},"e3f1c987-bd24-45ff-9997-9452ff86aea7":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","code":123,"error":"\u003cstring>","detail":"\u003cstring>","doc_url":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Bad Request - Invalid credentials or connection failure to the external datasource","exampleType":"generated"},"f4874578-18e9-44b2-8bcf-de25aab20085":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Unauthorized":{"title":"Unauthorized","value":{"id":null,"code":401,"error":"unauthorized","detail":"Authentication credentials were not provided or are invalid.","doc_url":"https://developers.lighton.ai/errors#unauthorized"}}},"exampleType":"examples"}},"description":"Authentication credentials were not provided or are invalid","exampleType":"examples"},"7399f3ab-de45-4f05-be70-84b341867b0c":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"error":{"type":"string","description":"Error code / translation key","isRequired":true,"uniqueKey":"fields.additionalProperties.items.[INDEX].error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description of the field error","isRequired":true,"uniqueKey":"fields.additionalProperties.items.[INDEX].detail","typeLabel":"string"}},"required":["detail","error"],"uniqueKey":"fields.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields.additionalProperties","typeLabel":"object[]"},"description":"Field-level validation errors keyed by field name","uniqueKey":"fields","typeLabel":"object"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"ValidationError":{"title":"ValidationError","value":{"id":null,"code":422,"error":"validation_error","detail":"One or more fields failed validation.","doc_url":"https://developers.lighton.ai/errors#validation_error","fields":{"\u003cfield_name>":[{"error":"required","detail":"This field is required."}]}}}},"exampleType":"examples"}},"description":"Request body is valid JSON but one or more fields failed validation","exampleType":"examples"},"29ef30e5-5201-496f-8e67-e2215b060c1c":{"description":"API is under maintenance. Check `GET /api/v3/system/status` for active periods and retry.","content":{"application/json":{"schema":{"type":"object","description":"Returned by the maintenance middleware when the requested endpoint is blocked.","required":["detail","error","mode"],"properties":{"detail":{"type":"string","example":"System is under maintenance.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"error":{"type":"string","example":"service_maintenance","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"mode":{"type":"string","enum":["full_shutdown","warning_banner"],"description":"`full_shutdown` blocks all traffic; `warning_banner` also blocks and shows a dismissible toast.","isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"Operator-supplied maintenance reason, if any.","uniqueKey":"reason","typeLabel":"string"},"started_at":{"type":"string","format":"date-time","uniqueKey":"started_at","typeLabel":"string\u003cdate-time>"},"endpoint_category_names":{"type":"array","items":{"type":"string","uniqueKey":"endpoint_category_names.items.[INDEX]","typeLabel":"string"},"description":"Non-empty only for category-scoped periods. Empty means all endpoints are affected.","uniqueKey":"endpoint_category_names","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"System is under maintenance.","error":"service_maintenance","mode":"full_shutdown","reason":"\u003cstring>","started_at":"2023-11-07T05:31:56Z","endpoint_category_names":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"fcc68fa4-a269-488d-9b45-98521d3b8f65":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","scopes":[]}}},"servers":{"48c3fa0c-537e-4ab8-b62c-fc02ab11f431":{"url":"https://api.lighton.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/api-console.yaml"},"subdomain":"lighton-developers","siteName":"LightOn Developers","title":"Browse datasource folders - LightOn Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-16T07:50:02.962Z","originalFileLocation":"api-reference/workspaces/browse-datasource-folders.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"⚠️ 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\u0026#x27;s document libraries as kind=\u0026quot;library\u0026quot; entries (each entry\u0026#x27;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\u0026#x27;s id as parent_id to descend into a folder.\">\u003cmeta data-mint-head name=\"application-name\" content=\"LightOn Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Browse datasource folders - LightOn Developers\">\u003cmeta data-mint-head property=\"og:description\" content=\"⚠️ 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\u0026#x27;s document libraries as kind=\u0026quot;library\u0026quot; entries (each entry\u0026#x27;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\u0026#x27;s id as parent_id to descend into a folder.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LightOn Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lighton-developers.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Browse+datasource+folders\u0026amp;description=%E2%9A%A0%EF%B8%8F+**ALPHA+ENDPOINT**+-+This+endpoint+is+in+alpha+and+subject+to+breaking+changes.+Use+with+caution+in+production+environments.%0A%0ABrowse+the+remote+folder+hierar\u0026amp;theme=f4a17457a3f509b4a9ccfb44\u0026amp;signature=8707f16519e2ae5cd16142a2457ea9be63846822d159c454f00c8dceede39bb2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Browse datasource folders - LightOn Developers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"⚠️ 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\u0026#x27;s document libraries as kind=\u0026quot;library\u0026quot; entries (each entry\u0026#x27;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\u0026#x27;s id as parent_id to descend into a folder.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lighton-developers.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Browse+datasource+folders\u0026amp;description=%E2%9A%A0%EF%B8%8F+**ALPHA+ENDPOINT**+-+This+endpoint+is+in+alpha+and+subject+to+breaking+changes.+Use+with+caution+in+production+environments.%0A%0ABrowse+the+remote+folder+hierar\u0026amp;theme=f4a17457a3f509b4a9ccfb44\u0026amp;signature=8707f16519e2ae5cd16142a2457ea9be63846822d159c454f00c8dceede39bb2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LightOn Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1f99bb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workspaces/browse-datasource-folders.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.lighton.ai/#organization\",\"name\":\"LightOn Developers\",\"url\":\"https://developers.lighton.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lighton-developers/dojq_qF_vSGGGm4-/logo/light.svg?fit=max\u0026auto=format\u0026n=dojq_qF_vSGGGm4-\u0026q=85\u0026s=345d3b10124f99971a7737a9f06f2886\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.lighton.ai#website\",\"name\":\"LightOn Developers\",\"url\":\"https://developers.lighton.ai\",\"publisher\":{\"@id\":\"https://developers.lighton.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders#webpage\",\"url\":\"https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders\",\"name\":\"Browse datasource folders\",\"description\":\"⚠️ 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.\",\"dateModified\":\"2026-09-16T07:50:02.962Z\",\"isPartOf\":{\"@id\":\"https://developers.lighton.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Intelligence\",\"item\":\"https://developers.lighton.ai/api-reference/ask/ask-a-question-over-your-documents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workspaces\",\"item\":\"https://developers.lighton.ai/api-reference/workspaces/list-workspaces\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Browse datasource folders\",\"item\":\"https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders#apireference\",\"headline\":\"Browse datasource folders\",\"name\":\"Browse datasource folders\",\"description\":\"⚠️ 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.\",\"url\":\"https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders\",\"mainEntityOfPage\":{\"@id\":\"https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders#webpage\"},\"dateModified\":\"2026-09-16T07:50:02.962Z\",\"publisher\":{\"@id\":\"https://developers.lighton.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.lighton.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LightOn Developers\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"LightOn Developers","nav":{"global":{"anchors":[{"anchor":"Playground","icon":"circle-play","href":"https://console.lighton.ai"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/introduction"},{"title":"API Errors","href":"/api-reference/v3-error-codes"}]},{"group":"Intelligence","pages":[{"title":"Ask a question over your documents","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/ask","href":"/api-reference/ask/ask-a-question-over-your-documents"},{"title":"Search document chunks","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/search","href":"/api-reference/search/search-document-chunks"},{"group":"Files","pages":[{"title":"List files accessible to the authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/files","href":"/api-reference/files/list-files-accessible-to-the-authenticated-user"},{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files","href":"/api-reference/files/upload-a-file"},{"title":"Delete multiple files in a single request","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files/bulk-delete","href":"/api-reference/files/delete-multiple-files-in-a-single-request"},{"title":"Retrieve a single file by ID","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/files/{id}","href":"/api-reference/files/retrieve-a-single-file-by-id"},{"title":"Update file metadata or replace its file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml patch /api/v3/files/{id}","href":"/api-reference/files/update-file-metadata-or-replace-its-file"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/files/{id}","href":"/api-reference/files/delete-a-file"},{"title":"Download a document file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/files/{id}/download","href":"/api-reference/files/download-a-document-file"},{"title":"Get document thumbnail","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/files/{id}/thumbnail","href":"/api-reference/files/get-document-thumbnail"}]},{"group":"Facets","pages":[{"title":"List content types","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/content-types","href":"/api-reference/facets/list-content-types"},{"title":"Define content types and attributes","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/content-types","href":"/api-reference/facets/define-content-types-and-attributes"},{"title":"Batch define content types and attributes","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/content-types/batch","href":"/api-reference/facets/batch-define-content-types-and-attributes"},{"title":"Resolve search scope","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/content-types/scope","href":"/api-reference/facets/resolve-search-scope"},{"title":"List content type templates","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/content-types/templates","href":"/api-reference/facets/list-content-type-templates"},{"title":"Resolve search scope","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/content-types/scope","href":"/api-reference/facets/resolve-search-scope"},{"title":"List file classifications and attribute values","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/files/{file_id}/facets","href":"/api-reference/facets/list-file-classifications-and-attribute-values"},{"title":"Classify file and set attribute values","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files/{file_id}/facets","href":"/api-reference/facets/classify-file-and-set-attribute-values"},{"title":"Batch classify and set attribute values","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files/{file_id}/facets/batch","href":"/api-reference/facets/batch-classify-and-set-attribute-values"}]},{"group":"Tags","pages":[{"title":"List all tags for the authenticated user's company","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/tags","href":"/api-reference/tags/list-all-tags-for-the-authenticated-users-company"},{"title":"Create a new tag for the company","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/tags","href":"/api-reference/tags/create-a-new-tag-for-the-company"},{"title":"Delete a company tag","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/tags/{id}","href":"/api-reference/tags/delete-a-company-tag"},{"title":"Add tags to a file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files/{id}/tags","href":"/api-reference/files/add-tags-to-a-file"},{"title":"Remove a tag from a file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/files/{id}/tags/{tag_id}","href":"/api-reference/files/remove-a-tag-from-a-file"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/workspaces","href":"/api-reference/workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/workspaces","href":"/api-reference/workspaces/create-a-workspace"},{"title":"Retrieve a workspace","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/workspaces/{id}","href":"/api-reference/workspaces/retrieve-a-workspace"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml patch /api/v3/workspaces/{id}","href":"/api-reference/workspaces/update-a-workspace"},{"title":"Delete a workspace","description":"⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.\n\nSoft-delete a custom workspace you own.\n\nThe workspace and its memberships are marked as deleted but retained for the configured recovery period; collection data (documents, chunks, embeddings) is preserved until the workspace is permanently deleted by the cleanup task. The workspace can be restored within the recovery period via `PATCH` with `deleted_at=null` (use `?include_deleted=true` to address it after deletion).\n\n**Restrictions:**\n- PERSONAL workspaces cannot be deleted (system-managed)\n- Caller must be an OWNER of the workspace (or hold instance/company workspace-delete permission)","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/workspaces/{id}","href":"/api-reference/workspaces/delete-a-workspace"},{"title":"Browse datasource folders","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/workspaces/datasource/browse","href":"/api-reference/workspaces/browse-datasource-folders"},{"title":"Test datasource credentials","description":"⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.\n\nTest datasource credentials without persisting anything.\n\nValidates 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.\n\n**Access:** any authenticated user.\n\nCredentials per type:\n- **googledrive**: `service_account_file` (JSON string of the service account key file)\n- **sharepoint**: `client_id`, `client_secret`, `tenant_id`, `site_id` (optional), `site_name` (optional)\n- **servicenow**: `instance_url`, `username`, `password`\n- **webscrapper**: no credentials required\n- **smb**: `instance_url` (`smb://host[:port]`), `username`, `password`\n\nFilter criteria per type:\n- **googledrive**: `folder_id` (required), `recursive` (optional)\n- **sharepoint**: `folder_path` (required), `recursive` (optional)\n- **servicenow**: `doc_type` (required, e.g. `knowledge`)\n- **webscrapper**: `start_url` (required)\n- **smb**: `share_name` (required), `path` (optional), `recursive` (optional)","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/workspaces/datasource/test","href":"/api-reference/workspaces/test-datasource-credentials"}]}]},{"group":"Document Processing","pages":[{"group":"Parse","pages":[{"title":"Parse a document to Markdown","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/parse","href":"/api-reference/parse/parse-a-document-to-markdown"},{"title":"Get the status and result of an async parse job","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/parse/{id}","href":"/api-reference/parse/get-the-status-and-result-of-an-async-parse-job"},{"title":"Render a document as PDF","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/preview","href":"/api-reference/parse/render-a-document-as-pdf"}]},{"group":"Extract","pages":[{"title":"Extract structured data from a document","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/extract","href":"/api-reference/extract/extract-structured-data-from-a-document"},{"title":"Get the status and result of an async extract job","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/extract/{job_id}","href":"/api-reference/extract/get-the-status-and-result-of-an-async-extract-job"}]}]},{"group":"Administration","pages":[{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/keys","href":"/api-reference/api-keys/create-api-key"},{"title":"Retrieve API key","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/keys/{id}","href":"/api-reference/api-keys/retrieve-api-key"},{"title":"Update API key","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml patch /api/v3/keys/{id}","href":"/api-reference/api-keys/update-api-key"},{"title":"Revoke API key","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/keys/{id}","href":"/api-reference/api-keys/revoke-api-key"}]},{"group":"Budget","pages":[{"title":"Get company budget","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/billing/budget","href":"/api-reference/budget/get-company-budget"},{"title":"Create or update company budget","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml put /api/v3/billing/budget","href":"/api-reference/budget/create-or-update-company-budget"},{"title":"Delete company budget","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/billing/budget","href":"/api-reference/budget/delete-company-budget"},{"title":"List budget alerts","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/billing/budget/alerts","href":"/api-reference/budget/list-budget-alerts"},{"title":"Create budget alert","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/billing/budget/alerts","href":"/api-reference/budget/create-budget-alert"},{"title":"Toggle all budget alerts","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml patch /api/v3/billing/budget/alerts","href":"/api-reference/budget/toggle-all-budget-alerts"},{"title":"Update budget alert","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml patch /api/v3/billing/budget/alerts/{id}","href":"/api-reference/budget/update-budget-alert"},{"title":"Delete budget alert","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/billing/budget/alerts/{id}","href":"/api-reference/budget/delete-budget-alert"}]}]}]},{"tab":"Tutorials","pages":[{"title":"Tutorials","href":"/tutorials"}]},{"tab":"Settings","pages":[{"title":"Settings","href":"/untitled-page"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp-server/quickstart"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks"}]},{"tab":"Use Cases","pages":[{"title":"Use Cases","href":"/use-cases"}]},{"tab":"Legal","pages":[{"title":"Legal","href":"/legal/terms-of-use"}]},{"tab":"Support","pages":[{"title":"Support","href":"/support"}]}]},"basePath":"","title":"Browse datasource folders - LightOn Developers","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}