Generate OAuth URL
Please note that not all connectors use OAuth, like Gitbook or Freshdesk. Please use the connector specific endpoints for authentication in those cases.
Authorizations
token <token>, corresponds to temporary access tokens.
Body
BOX, CONFLUENCE, DROPBOX, GMAIL, GOOGLE_DRIVE, GOOGLE_CLOUD_STORAGE, INTERCOM, NOTION, ONEDRIVE, OUTLOOK, SALESFORCE, SHAREPOINT, SLACK, ZENDESK, ZOTERO, GONG, SERVICENOW List of scopes to request from the OAuth provider. Please that the scopes will be used as it is, not combined with the default props that Carbon uses. One scope should be one array element.
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
Used to specify a data source to sync from if you have multiple connected. It can be skipped if you only have one data source of that type connected or are connecting a new account.
Used to connect a new data source. If not specified, we will attempt to create a sync URL for an existing data source based on type and ID.
This request id will be added to all files that get synced using the generated OAuth URL
Enable OCR for files that support it. Supported formats: pdf, png, jpg
Enable integration's file picker for sources that support it. Supported sources: BOX, DROPBOX, GOOGLE_DRIVE, ONEDRIVE, SHAREPOINT
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 (automatic or through connector's inbuilt file picker) on completion of the OAuth flow
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.
If you are connecting a Gong account, you need to input the email of the account you wish to connect. This email will be used to identify your carbon data source.
ServiceNow credentials required to connect a ServiceNow account. The instance_subdomain can be extracted from the url of the instance url which takes the form of "<instance-subdomain>.service-now.com". The client_id and client_secret are values generated by creating a new OAuth API Integration in ServiceNow. When creating the OAuth API Integration, the redirect uri must be "https://api.carbon.ai/integrations/servicenow" or a similar one using a CNAME.
Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.