- Documentation
- GETHealth
- POSTUpload File
- POSTUpload Text
- POSTUpload File via URL
- POSTView Files
- POSTDelete Files V2
- POSTResync File
- POSTWeb Scrape
- POSTScrape Sitemap
- POSTFetch Webpage
- POSTView Webpages
- GETFetch Sitemap URLs
- GETYouTube Transcript
- GETWeb Search
- POSTSync RSS Feed
- POSTRevoke Connection
- POSTView Connections
- POSTAdd Connection
- POSTSync Connection
- POSTList Connection Items
- POSTSync Connection Files
- POSTSearch
Health
Files
Web Scrape
Data Source
Retrieval
Add Connection
You can bypass the authentication flow on Carbon by directly passing in an access token. This endpoint eliminates the need for users to go through the typical authentication flow. By providing the access token directly, users can gain immediate access to Carbon’s features and functionality without any additional steps.
token <token>, corresponds to temporary access tokens.
Number of objects per chunk. For csv, tsv, xlsx, and json files only.
Used to specify whether Carbon should attempt to sync all your files automatically when authorization is complete. This is only supported for a subset of connectors and will be ignored for the rest. Supported connectors: Intercom, Zendesk, Gitbook, Confluence, Salesforce, Freshdesk
Enabling this flag will fetch all available content from the source to be listed via list items endpoint
Only sync files if they have not already been synced or if the embedding properties have changed. This flag is currently supported by ONEDRIVE, GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK. It will be ignored for other data sources.
Used to configure file syncing for certain connectors when sync_files_on_connection is set to true
File types to automatically sync when the data source connects. Only a subset of file types can be controlled. If not supported, then they will always be synced
Automatically sync attachments from files where supported. Currently applies to Helpdesk Tickets
Detect audio language before transcription for audio files
The transcription service to use for audio files. If no service is specified, 'deepgram' will be used.
Whether to split tabular rows into chunks. Currently only valid for CSV, TSV, and XLSX files.
Authorizations
token <token>, corresponds to temporary access tokens.
Body
GOOGLE_DRIVE, INTERCOM, DROPBOX, ONEDRIVE, BOX, GMAIL, OUTLOOK, SLACK OPENAI, AZURE_OPENAI, AZURE_ADA_LARGE_256, AZURE_ADA_LARGE_1024, AZURE_ADA_LARGE_3072, AZURE_ADA_SMALL_512, AZURE_ADA_SMALL_1536, COHERE_MULTILINGUAL_V3, VERTEX_MULTIMODAL, OPENAI_ADA_LARGE_256, OPENAI_ADA_LARGE_1024, OPENAI_ADA_LARGE_3072, OPENAI_ADA_SMALL_512, OPENAI_ADA_SMALL_1536, SOLAR_1_MINI Number of objects per chunk. For csv, tsv, xlsx, and json files only.
Used to specify whether Carbon should attempt to sync all your files automatically when authorization is complete. This is only supported for a subset of connectors and will be ignored for the rest. Supported connectors: Intercom, Zendesk, Gitbook, Confluence, Salesforce, Freshdesk
Enabling this flag will fetch all available content from the source to be listed via list items endpoint
Only sync files if they have not already been synced or if the embedding properties have changed. This flag is currently supported by ONEDRIVE, GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK. It will be ignored for other data sources.
Used to configure file syncing for certain connectors when sync_files_on_connection is set to true
File types to automatically sync when the data source connects. Only a subset of file types can be controlled. If not supported, then they will always be synced
TICKET, ARTICLE Automatically sync attachments from files where supported. Currently applies to Helpdesk Tickets
Detect audio language before transcription for audio files
The transcription service to use for audio files. If no service is specified, 'deepgram' will be used.
assemblyai, deepgram Whether to split tabular rows into chunks. Currently only valid for CSV, TSV, and XLSX files.
Response
GOOGLE_DRIVE, NOTION, NOTION_DATABASE, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, BOX, ZENDESK, ZOTERO, S3, GMAIL, OUTLOOK, TEXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, HTML, RAW_TEXT, WEB_SCRAPE, RSS_FEED, FRESHDESK, GITBOOK, SALESFORCE, GITHUB, SLACK, JPG, PNG, JPEG, MP3, MP2, AAC, WAV, FLAC, PCM, M4A, OGG, OPUS, MPEG, MPG, MP4, WMV, AVI, MOV, MKV, FLV, WEBM, EML QUEUED_FOR_SYNCING, SYNCING, READY, SYNC_ERROR ADD, UPDATE, CANCEL, REVOKE