API Documentation
Health
Files
Web Scrape
Data Source
SharePoint
GitHub
Chunks / Embeddings
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.
curl --request POST \
--url https://api.carbon.ai/integrations/connect \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"authentication": {
"source": "GOOGLE_DRIVE",
"access_token": "<string>",
"refresh_token": "<string>"
},
"sync_options": {
"chunk_size": 1500,
"chunk_overlap": 20,
"skip_embedding_generation": false,
"embedding_model": "OPENAI",
"generate_sparse_vectors": false,
"prepend_filename_to_chunks": false,
"sync_files_on_connection": true,
"set_page_as_boundary": false,
"enable_file_picker": true,
"sync_source_items": true,
"incremental_sync": false,
"data_source_tags": {}
}
}'{
"data_source": {
"id": 123,
"data_source_external_id": "<string>",
"data_source_type": "GOOGLE_CLOUD_STORAGE",
"token": {},
"sync_status": "QUEUED_FOR_SYNCING",
"source_items_synced_at": "2023-11-07T05:31:56Z",
"organization_user_id": 123,
"organization_id": 123,
"organization_supplied_user_id": "<string>",
"revoked_access": true,
"last_synced_at": "2023-11-07T05:31:56Z",
"last_sync_action": "ADD",
"enable_auto_sync": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"files_synced_at": "2023-11-07T05:31:56Z",
"data_source_metadata": {},
"tags": {}
},
"sync_url": "<string>"
}Authorizations
token <token>, corresponds to temporary access tokens.
Body
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.
x > 0Used 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, ZENDESK, CONFLUENCE, NOTION, SHAREPOINT, SERVICENOW. 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, CONVERSATION 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 Detect multiple speakers and label segments of speech by speaker for audio files.
Whether to split tabular rows into chunks. Currently only valid for CSV, TSV, and XLSX files.
If this flag is enabled, the file will be chunked and stored with Carbon, but no embeddings will be generated. This overrides the skip_embedding_generation flag.
If this flag is enabled, the file will be stored with Carbon, but no chunks or embeddings will be generated. This overrides the skip_embedding_generation and generate_chunks_only flags.
Setting this flag will create a new file record with Carbon but skip any and all processing. This means that we do not download the remote file content or generate any chunks or embeddings. We will store some metadata like name, external id, and external URL depending on the source you are syncing from. Note that this flag overrides both skip_embedding_generation and generate_chunks_only flags. The file will be moved to READY_TO_SYNC status.
Automatically open source file picker after the OAuth flow is complete. This flag is currently supported by BOX, DROPBOX, GOOGLE_DRIVE, ONEDRIVE, SHAREPOINT. It will be ignored for other data sources.
Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.
Response
GOOGLE_CLOUD_STORAGE, GOOGLE_DRIVE, NOTION, NOTION_DATABASE, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, BOX, ZENDESK, ZOTERO, S3, AZURE_BLOB_STORAGE, GMAIL, OUTLOOK, SERVICENOW, TEXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, XLSM, MD, RTF, JSON, HTML, RAW_TEXT, WEB_SCRAPE, RSS_FEED, FRESHDESK, GITBOOK, SALESFORCE, GITHUB, SLACK, GURU, GONG, DOCUMENT360, JPG, PNG, JPEG, MP3, MP2, AAC, WAV, FLAC, PCM, M4A, OGG, OPUS, MPEG, MPG, MP4, WMV, AVI, MOV, MKV, FLV, WEBM, EML, MSG QUEUED_FOR_SYNCING, SYNCING, READY, SYNC_ERROR ADD, UPDATE, CANCEL, REVOKE curl --request POST \
--url https://api.carbon.ai/integrations/connect \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '{
"authentication": {
"source": "GOOGLE_DRIVE",
"access_token": "<string>",
"refresh_token": "<string>"
},
"sync_options": {
"chunk_size": 1500,
"chunk_overlap": 20,
"skip_embedding_generation": false,
"embedding_model": "OPENAI",
"generate_sparse_vectors": false,
"prepend_filename_to_chunks": false,
"sync_files_on_connection": true,
"set_page_as_boundary": false,
"enable_file_picker": true,
"sync_source_items": true,
"incremental_sync": false,
"data_source_tags": {}
}
}'{
"data_source": {
"id": 123,
"data_source_external_id": "<string>",
"data_source_type": "GOOGLE_CLOUD_STORAGE",
"token": {},
"sync_status": "QUEUED_FOR_SYNCING",
"source_items_synced_at": "2023-11-07T05:31:56Z",
"organization_user_id": 123,
"organization_id": 123,
"organization_supplied_user_id": "<string>",
"revoked_access": true,
"last_synced_at": "2023-11-07T05:31:56Z",
"last_sync_action": "ADD",
"enable_auto_sync": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"files_synced_at": "2023-11-07T05:31:56Z",
"data_source_metadata": {},
"tags": {}
},
"sync_url": "<string>"
}