ModelsExpand Collapse PipelineDataSource { id , component , data_source_id , 13 more }
Schema for a data source in a pipeline.
Component that implements the data source
One of the following:
CloudS3DataSource { bucket , aws_access_id , aws_access_secret , 5 more }
The name of the S3 bucket to read from.
aws_access_id ? : string | null
The AWS access ID to use for authentication.
aws_access_secret ? : string | null
The AWS access secret to use for authentication.
The prefix of the S3 objects to read from.
regex_pattern ? : string | null
The regex pattern to filter S3 objects. Must be a valid regex pattern.
s3_endpoint_url ? : string | null
The S3 endpoint URL to use for authentication.
supports_access_control ? : boolean
CloudAzStorageBlobDataSource { account_url , container_name , account_key , 8 more }
The Azure Storage Blob account URL to use for authentication.
The name of the Azure Storage Blob container to read from.
account_key ? : string | null
The Azure Storage Blob account key to use for authentication.
account_name ? : string | null
The Azure Storage Blob account name to use for authentication.
The blob name to read from.
client_id ? : string | null
The Azure AD client ID to use for authentication.
client_secret ? : string | null
The Azure AD client secret to use for authentication.
The prefix of the Azure Storage Blob objects to read from.
supports_access_control ? : boolean
tenant_id ? : string | null
The Azure AD tenant ID to use for authentication.
CloudGoogleDriveDataSource { folder_id , class_name , service_account_key , supports_access_control }
The ID of the Google Drive folder to read from.
service_account_key ? : Record< string , string > | null
A dictionary containing secret values
supports_access_control ? : boolean
CloudOneDriveDataSource { client_id , client_secret , tenant_id , 6 more }
The client ID to use for authentication.
The client secret to use for authentication.
The tenant ID to use for authentication.
user_principal_name : string
The user principal name to use for authentication.
folder_id ? : string | null
The ID of the OneDrive folder to read from.
folder_path ? : string | null
The path of the OneDrive folder to read from.
required_exts ? : Array< string > | null
The list of required file extensions.
supports_access_control ? : true
CloudSharepointDataSource { client_id , client_secret , tenant_id , 11 more }
The client ID to use for authentication.
The client secret to use for authentication.
The tenant ID to use for authentication.
drive_name ? : string | null
The name of the Sharepoint drive to read from.
exclude_path_patterns ? : Array< string > | null
List of regex patterns for file paths to exclude. Files whose paths (including filename) match any pattern will be excluded. Example: [‘/temp/’, ‘/backup/’, ‘.git/’, ‘.tmp$’, ’^~’]
folder_id ? : string | null
The ID of the Sharepoint folder to read from.
folder_path ? : string | null
The path of the Sharepoint folder to read from.
get_permissions ? : boolean
Whether to get permissions for the sharepoint site.
include_path_patterns ? : Array< string > | null
List of regex patterns for file paths to include. Full paths (including filename) must match at least one pattern to be included. Example: [‘/reports/’, ‘/docs/..pdf$’, ‘^Report. .pdf$’]
required_exts ? : Array< string > | null
The list of required file extensions.
The ID of the SharePoint site to download from.
site_name ? : string | null
The name of the SharePoint site to download from.
supports_access_control ? : true
CloudSlackDataSource { slack_token , channel_ids , channel_patterns , 6 more }
channel_ids ? : string | null
channel_patterns ? : string | null
Slack Channel name pattern.
earliest_date ? : string | null
earliest_date_timestamp ? : number | null
latest_date ? : string | null
latest_date_timestamp ? : number | null
supports_access_control ? : boolean
CloudNotionPageDataSource { integration_token , class_name , database_ids , 2 more }
integration_token : string
The integration token to use for authentication.
database_ids ? : string | null
The Notion Database Id to read content from.
The Page ID’s of the Notion to read from.
supports_access_control ? : boolean
CloudConfluenceDataSource { authentication_mechanism , server_url , api_token , 11 more }
authentication_mechanism : string
Type of Authentication for connecting to Confluence APIs.
The server URL of the Confluence instance.
api_token ? : string | null
The API token to use for authentication.
The CQL query to use for fetching pages.
Configuration for handling failures during processing. Key-value object controlling failure handling behaviors.
Example:
{
“skip_list_failures”: true
}
Currently supports:
skip_list_failures: Skip failed batches/lists and continue processing
skip_list_failures ? : boolean
Whether to skip failed batches/lists and continue processing
index_restricted_pages ? : boolean
Whether to index restricted pages.
Whether to keep the markdown format.
The label to use for fetching pages.
The page IDs of the Confluence to read from.
space_key ? : string | null
The space key to read from.
supports_access_control ? : boolean
sync_permissions ? : boolean
Whether to fetch space-level permissions (allowed users/groups) and attach them to document metadata for access control. Disable for Confluence Server/Data Center versions whose permission APIs are unavailable (e.g. the JSON-RPC API removed in Data Center 9.2.6+), which otherwise surface as 401 errors during sync.
user_name ? : string | null
The username to use for authentication.
CloudJiraDataSource { authentication_mechanism , query , api_token , 5 more }
Cloud Jira Data Source integrating JiraReader.
authentication_mechanism : string
Type of Authentication for connecting to Jira APIs.
JQL (Jira Query Language) query to search.
api_token ? : string | null
The API/ Access Token used for Basic, PAT and OAuth2 authentication.
The cloud ID, used in case of OAuth2.
The email address to use for authentication.
server_url ? : string | null
The server url for Jira Cloud.
supports_access_control ? : boolean
CloudJiraDataSourceV2 { authentication_mechanism , query , server_url , 10 more }
Cloud Jira Data Source integrating JiraReaderV2.
authentication_mechanism : string
Type of Authentication for connecting to Jira APIs.
JQL (Jira Query Language) query to search.
The server url for Jira Cloud.
api_token ? : string | null
The API Access Token used for Basic, PAT and OAuth2 authentication.
Jira REST API version to use (2 or 3). 3 supports Atlassian Document Format (ADF).
The cloud ID, used in case of OAuth2.
The email address to use for authentication.
Fields to expand in the response.
fields ? : Array< string > | null
List of fields to retrieve from Jira. If None, retrieves all fields.
get_permissions ? : boolean
Whether to fetch project role permissions and issue-level security
requests_per_minute ? : number | null
Rate limit for Jira API requests per minute.
supports_access_control ? : boolean
CloudBoxDataSource { authentication_mechanism , class_name , client_id , 6 more }
authentication_mechanism : "developer_token" | "ccg"
The type of authentication to use (Developer Token or CCG)
client_id ? : string | null
Box API key used for identifying the application the user is authenticating with
client_secret ? : string | null
Box API secret used for making auth requests.
developer_token ? : string | null
Developer token for authentication if authentication_mechanism is ‘developer_token’.
enterprise_id ? : string | null
Box Enterprise ID, if provided authenticates as service.
folder_id ? : string | null
The ID of the Box folder to read from.
supports_access_control ? : boolean
Box User ID, if provided authenticates as user.
The ID of the data source.
The last time the data source was automatically synced.
The name of the data source.
source_type : "S3" | "AZURE_STORAGE_BLOB" | "GOOGLE_DRIVE" | 8 more
created_at ? : string | null
Custom metadata that will be present on all data loaded from the data source
status ? : "NOT_STARTED" | "IN_PROGRESS" | "SUCCESS" | 2 more | null
The status of the data source in the pipeline.
status_updated_at ? : string | null
The last time the status was updated.
sync_interval ? : number | null
The interval at which the data source should be synced.
sync_schedule_set_by ? : string | null
The id of the user who set the sync schedule.
updated_at ? : string | null
Version metadata for the data source
The version of the reader to use for this data source.
DataSourceGetDataSourcesResponse = Array< PipelineDataSource { id , component , data_source_id , 13 more } > Component that implements the data source
One of the following:
CloudS3DataSource { bucket , aws_access_id , aws_access_secret , 5 more }
The name of the S3 bucket to read from.
aws_access_id ? : string | null
The AWS access ID to use for authentication.
aws_access_secret ? : string | null
The AWS access secret to use for authentication.
The prefix of the S3 objects to read from.
regex_pattern ? : string | null
The regex pattern to filter S3 objects. Must be a valid regex pattern.
s3_endpoint_url ? : string | null
The S3 endpoint URL to use for authentication.
supports_access_control ? : boolean
CloudAzStorageBlobDataSource { account_url , container_name , account_key , 8 more }
The Azure Storage Blob account URL to use for authentication.
The name of the Azure Storage Blob container to read from.
account_key ? : string | null
The Azure Storage Blob account key to use for authentication.
account_name ? : string | null
The Azure Storage Blob account name to use for authentication.
The blob name to read from.
client_id ? : string | null
The Azure AD client ID to use for authentication.
client_secret ? : string | null
The Azure AD client secret to use for authentication.
The prefix of the Azure Storage Blob objects to read from.
supports_access_control ? : boolean
tenant_id ? : string | null
The Azure AD tenant ID to use for authentication.
CloudGoogleDriveDataSource { folder_id , class_name , service_account_key , supports_access_control }
The ID of the Google Drive folder to read from.
service_account_key ? : Record< string , string > | null
A dictionary containing secret values
supports_access_control ? : boolean
CloudOneDriveDataSource { client_id , client_secret , tenant_id , 6 more }
The client ID to use for authentication.
The client secret to use for authentication.
The tenant ID to use for authentication.
user_principal_name : string
The user principal name to use for authentication.
folder_id ? : string | null
The ID of the OneDrive folder to read from.
folder_path ? : string | null
The path of the OneDrive folder to read from.
required_exts ? : Array< string > | null
The list of required file extensions.
supports_access_control ? : true
CloudSharepointDataSource { client_id , client_secret , tenant_id , 11 more }
The client ID to use for authentication.
The client secret to use for authentication.
The tenant ID to use for authentication.
drive_name ? : string | null
The name of the Sharepoint drive to read from.
exclude_path_patterns ? : Array< string > | null
List of regex patterns for file paths to exclude. Files whose paths (including filename) match any pattern will be excluded. Example: [‘/temp/’, ‘/backup/’, ‘.git/’, ‘.tmp$’, ’^~’]
folder_id ? : string | null
The ID of the Sharepoint folder to read from.
folder_path ? : string | null
The path of the Sharepoint folder to read from.
get_permissions ? : boolean
Whether to get permissions for the sharepoint site.
include_path_patterns ? : Array< string > | null
List of regex patterns for file paths to include. Full paths (including filename) must match at least one pattern to be included. Example: [‘/reports/’, ‘/docs/..pdf$’, ‘^Report. .pdf$’]
required_exts ? : Array< string > | null
The list of required file extensions.
The ID of the SharePoint site to download from.
site_name ? : string | null
The name of the SharePoint site to download from.
supports_access_control ? : true
CloudSlackDataSource { slack_token , channel_ids , channel_patterns , 6 more }
channel_ids ? : string | null
channel_patterns ? : string | null
Slack Channel name pattern.
earliest_date ? : string | null
earliest_date_timestamp ? : number | null
latest_date ? : string | null
latest_date_timestamp ? : number | null
supports_access_control ? : boolean
CloudNotionPageDataSource { integration_token , class_name , database_ids , 2 more }
integration_token : string
The integration token to use for authentication.
database_ids ? : string | null
The Notion Database Id to read content from.
The Page ID’s of the Notion to read from.
supports_access_control ? : boolean
CloudConfluenceDataSource { authentication_mechanism , server_url , api_token , 11 more }
authentication_mechanism : string
Type of Authentication for connecting to Confluence APIs.
The server URL of the Confluence instance.
api_token ? : string | null
The API token to use for authentication.
The CQL query to use for fetching pages.
Configuration for handling failures during processing. Key-value object controlling failure handling behaviors.
Example:
{
“skip_list_failures”: true
}
Currently supports:
skip_list_failures: Skip failed batches/lists and continue processing
skip_list_failures ? : boolean
Whether to skip failed batches/lists and continue processing
index_restricted_pages ? : boolean
Whether to index restricted pages.
Whether to keep the markdown format.
The label to use for fetching pages.
The page IDs of the Confluence to read from.
space_key ? : string | null
The space key to read from.
supports_access_control ? : boolean
sync_permissions ? : boolean
Whether to fetch space-level permissions (allowed users/groups) and attach them to document metadata for access control. Disable for Confluence Server/Data Center versions whose permission APIs are unavailable (e.g. the JSON-RPC API removed in Data Center 9.2.6+), which otherwise surface as 401 errors during sync.
user_name ? : string | null
The username to use for authentication.
CloudJiraDataSource { authentication_mechanism , query , api_token , 5 more }
Cloud Jira Data Source integrating JiraReader.
authentication_mechanism : string
Type of Authentication for connecting to Jira APIs.
JQL (Jira Query Language) query to search.
api_token ? : string | null
The API/ Access Token used for Basic, PAT and OAuth2 authentication.
The cloud ID, used in case of OAuth2.
The email address to use for authentication.
server_url ? : string | null
The server url for Jira Cloud.
supports_access_control ? : boolean
CloudJiraDataSourceV2 { authentication_mechanism , query , server_url , 10 more }
Cloud Jira Data Source integrating JiraReaderV2.
authentication_mechanism : string
Type of Authentication for connecting to Jira APIs.
JQL (Jira Query Language) query to search.
The server url for Jira Cloud.
api_token ? : string | null
The API Access Token used for Basic, PAT and OAuth2 authentication.
Jira REST API version to use (2 or 3). 3 supports Atlassian Document Format (ADF).
The cloud ID, used in case of OAuth2.
The email address to use for authentication.
Fields to expand in the response.
fields ? : Array< string > | null
List of fields to retrieve from Jira. If None, retrieves all fields.
get_permissions ? : boolean
Whether to fetch project role permissions and issue-level security
requests_per_minute ? : number | null
Rate limit for Jira API requests per minute.
supports_access_control ? : boolean
CloudBoxDataSource { authentication_mechanism , class_name , client_id , 6 more }
authentication_mechanism : "developer_token" | "ccg"
The type of authentication to use (Developer Token or CCG)
client_id ? : string | null
Box API key used for identifying the application the user is authenticating with
client_secret ? : string | null
Box API secret used for making auth requests.
developer_token ? : string | null
Developer token for authentication if authentication_mechanism is ‘developer_token’.
enterprise_id ? : string | null
Box Enterprise ID, if provided authenticates as service.
folder_id ? : string | null
The ID of the Box folder to read from.
supports_access_control ? : boolean
Box User ID, if provided authenticates as user.
The ID of the data source.
The last time the data source was automatically synced.
The name of the data source.
source_type : "S3" | "AZURE_STORAGE_BLOB" | "GOOGLE_DRIVE" | 8 more
created_at ? : string | null
Custom metadata that will be present on all data loaded from the data source
status ? : "NOT_STARTED" | "IN_PROGRESS" | "SUCCESS" | 2 more | null
The status of the data source in the pipeline.
status_updated_at ? : string | null
The last time the status was updated.
sync_interval ? : number | null
The interval at which the data source should be synced.
sync_schedule_set_by ? : string | null
The id of the user who set the sync schedule.
updated_at ? : string | null
Version metadata for the data source
The version of the reader to use for this data source.
DataSourceUpdateDataSourcesResponse = Array< PipelineDataSource { id , component , data_source_id , 13 more } > Component that implements the data source
One of the following:
CloudS3DataSource { bucket , aws_access_id , aws_access_secret , 5 more }
The name of the S3 bucket to read from.
aws_access_id ? : string | null
The AWS access ID to use for authentication.
aws_access_secret ? : string | null
The AWS access secret to use for authentication.
The prefix of the S3 objects to read from.
regex_pattern ? : string | null
The regex pattern to filter S3 objects. Must be a valid regex pattern.
s3_endpoint_url ? : string | null
The S3 endpoint URL to use for authentication.
supports_access_control ? : boolean
CloudAzStorageBlobDataSource { account_url , container_name , account_key , 8 more }
The Azure Storage Blob account URL to use for authentication.
The name of the Azure Storage Blob container to read from.
account_key ? : string | null
The Azure Storage Blob account key to use for authentication.
account_name ? : string | null
The Azure Storage Blob account name to use for authentication.
The blob name to read from.
client_id ? : string | null
The Azure AD client ID to use for authentication.
client_secret ? : string | null
The Azure AD client secret to use for authentication.
The prefix of the Azure Storage Blob objects to read from.
supports_access_control ? : boolean
tenant_id ? : string | null
The Azure AD tenant ID to use for authentication.
CloudGoogleDriveDataSource { folder_id , class_name , service_account_key , supports_access_control }
The ID of the Google Drive folder to read from.
service_account_key ? : Record< string , string > | null
A dictionary containing secret values
supports_access_control ? : boolean
CloudOneDriveDataSource { client_id , client_secret , tenant_id , 6 more }
The client ID to use for authentication.
The client secret to use for authentication.
The tenant ID to use for authentication.
user_principal_name : string
The user principal name to use for authentication.
folder_id ? : string | null
The ID of the OneDrive folder to read from.
folder_path ? : string | null
The path of the OneDrive folder to read from.
required_exts ? : Array< string > | null
The list of required file extensions.
supports_access_control ? : true
CloudSharepointDataSource { client_id , client_secret , tenant_id , 11 more }
The client ID to use for authentication.
The client secret to use for authentication.
The tenant ID to use for authentication.
drive_name ? : string | null
The name of the Sharepoint drive to read from.
exclude_path_patterns ? : Array< string > | null
List of regex patterns for file paths to exclude. Files whose paths (including filename) match any pattern will be excluded. Example: [‘/temp/’, ‘/backup/’, ‘.git/’, ‘.tmp$’, ’^~’]
folder_id ? : string | null
The ID of the Sharepoint folder to read from.
folder_path ? : string | null
The path of the Sharepoint folder to read from.
get_permissions ? : boolean
Whether to get permissions for the sharepoint site.
include_path_patterns ? : Array< string > | null
List of regex patterns for file paths to include. Full paths (including filename) must match at least one pattern to be included. Example: [‘/reports/’, ‘/docs/..pdf$’, ‘^Report. .pdf$’]
required_exts ? : Array< string > | null
The list of required file extensions.
The ID of the SharePoint site to download from.
site_name ? : string | null
The name of the SharePoint site to download from.
supports_access_control ? : true
CloudSlackDataSource { slack_token , channel_ids , channel_patterns , 6 more }
channel_ids ? : string | null
channel_patterns ? : string | null
Slack Channel name pattern.
earliest_date ? : string | null
earliest_date_timestamp ? : number | null
latest_date ? : string | null
latest_date_timestamp ? : number | null
supports_access_control ? : boolean
CloudNotionPageDataSource { integration_token , class_name , database_ids , 2 more }
integration_token : string
The integration token to use for authentication.
database_ids ? : string | null
The Notion Database Id to read content from.
The Page ID’s of the Notion to read from.
supports_access_control ? : boolean
CloudConfluenceDataSource { authentication_mechanism , server_url , api_token , 11 more }
authentication_mechanism : string
Type of Authentication for connecting to Confluence APIs.
The server URL of the Confluence instance.
api_token ? : string | null
The API token to use for authentication.
The CQL query to use for fetching pages.
Configuration for handling failures during processing. Key-value object controlling failure handling behaviors.
Example:
{
“skip_list_failures”: true
}
Currently supports:
skip_list_failures: Skip failed batches/lists and continue processing
skip_list_failures ? : boolean
Whether to skip failed batches/lists and continue processing
index_restricted_pages ? : boolean
Whether to index restricted pages.
Whether to keep the markdown format.
The label to use for fetching pages.
The page IDs of the Confluence to read from.
space_key ? : string | null
The space key to read from.
supports_access_control ? : boolean
sync_permissions ? : boolean
Whether to fetch space-level permissions (allowed users/groups) and attach them to document metadata for access control. Disable for Confluence Server/Data Center versions whose permission APIs are unavailable (e.g. the JSON-RPC API removed in Data Center 9.2.6+), which otherwise surface as 401 errors during sync.
user_name ? : string | null
The username to use for authentication.
CloudJiraDataSource { authentication_mechanism , query , api_token , 5 more }
Cloud Jira Data Source integrating JiraReader.
authentication_mechanism : string
Type of Authentication for connecting to Jira APIs.
JQL (Jira Query Language) query to search.
api_token ? : string | null
The API/ Access Token used for Basic, PAT and OAuth2 authentication.
The cloud ID, used in case of OAuth2.
The email address to use for authentication.
server_url ? : string | null
The server url for Jira Cloud.
supports_access_control ? : boolean
CloudJiraDataSourceV2 { authentication_mechanism , query , server_url , 10 more }
Cloud Jira Data Source integrating JiraReaderV2.
authentication_mechanism : string
Type of Authentication for connecting to Jira APIs.
JQL (Jira Query Language) query to search.
The server url for Jira Cloud.
api_token ? : string | null
The API Access Token used for Basic, PAT and OAuth2 authentication.
Jira REST API version to use (2 or 3). 3 supports Atlassian Document Format (ADF).
The cloud ID, used in case of OAuth2.
The email address to use for authentication.
Fields to expand in the response.
fields ? : Array< string > | null
List of fields to retrieve from Jira. If None, retrieves all fields.
get_permissions ? : boolean
Whether to fetch project role permissions and issue-level security
requests_per_minute ? : number | null
Rate limit for Jira API requests per minute.
supports_access_control ? : boolean
CloudBoxDataSource { authentication_mechanism , class_name , client_id , 6 more }
authentication_mechanism : "developer_token" | "ccg"
The type of authentication to use (Developer Token or CCG)
client_id ? : string | null
Box API key used for identifying the application the user is authenticating with
client_secret ? : string | null
Box API secret used for making auth requests.
developer_token ? : string | null
Developer token for authentication if authentication_mechanism is ‘developer_token’.
enterprise_id ? : string | null
Box Enterprise ID, if provided authenticates as service.
folder_id ? : string | null
The ID of the Box folder to read from.
supports_access_control ? : boolean
Box User ID, if provided authenticates as user.
The ID of the data source.
The last time the data source was automatically synced.
The name of the data source.
source_type : "S3" | "AZURE_STORAGE_BLOB" | "GOOGLE_DRIVE" | 8 more
created_at ? : string | null
Custom metadata that will be present on all data loaded from the data source
status ? : "NOT_STARTED" | "IN_PROGRESS" | "SUCCESS" | 2 more | null
The status of the data source in the pipeline.
status_updated_at ? : string | null
The last time the status was updated.
sync_interval ? : number | null
The interval at which the data source should be synced.
sync_schedule_set_by ? : string | null
The id of the user who set the sync schedule.
updated_at ? : string | null
Version metadata for the data source
The version of the reader to use for this data source.
Note for AI agents: this documentation is built for programmatic access.
- Overview of all docs: https://developers.llamaindex.ai/llms.txt
- Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md
- Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters.
- A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/
