POST
/
integrations
/
oauth_url
curl --request POST \
  --url https://api.carbon.ai/integrations/oauth_url \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '{
  "scope": "<string>",
  "service": "GOOGLE_DRIVE",
  "tags": "<any>",
  "chunk_size": 123,
  "chunk_overlap": 123,
  "skip_embedding_generation": true,
  "embedding_model": "OPENAI",
  "zendesk_subdomain": "<string>",
  "microsoft_tenant": "<string>",
  "sharepoint_site_name": "<string>",
  "confluence_subdomain": "<string>",
  "generate_sparse_vectors": true,
  "prepend_filename_to_chunks": true,
  "max_items_per_chunk": 1,
  "salesforce_domain": "<string>",
  "sync_files_on_connection": true,
  "set_page_as_boundary": true,
  "data_source_id": 123,
  "connecting_new_account": true,
  "request_id": "<string>",
  "use_ocr": true,
  "parse_pdf_tables_with_ocr": true,
  "enable_file_picker": true
}'
{
  "oauth_url": "<string>"
}

Authorizations

authorization
string
headerrequired

token <token>, corresponds to temporary access tokens.

Body

application/json
scope
string | null
service
enum<string>
required
Available options:
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,
RAW_TEXT,
WEB_SCRAPE,
RSS_FEED,
FRESHDESK,
GITBOOK,
SALESFORCE,
GITHUB,
JPG,
PNG,
JPEG,
MP3,
MP4,
MP2,
AAC,
WAV,
FLAC,
PCM,
M4A,
OGG,
OPUS,
WEBM
tags
any | null
chunk_size
integer | null
chunk_overlap
integer | null
skip_embedding_generation
boolean | null
embedding_model
enum<string> | null
Available options:
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
zendesk_subdomain
string | null
microsoft_tenant
string | null
sharepoint_site_name
string | null
confluence_subdomain
string | null
generate_sparse_vectors
boolean | null
prepend_filename_to_chunks
boolean | null
max_items_per_chunk
integer | null

Number of objects per chunk. For csv, tsv, xlsx, and json files only.

salesforce_domain
string | null
sync_files_on_connection
boolean | null

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

set_page_as_boundary
boolean
default: false
data_source_id
integer | null

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.

connecting_new_account
boolean | null

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.

request_id
string | null

This request id will be added to all files that get synced using the generated OAuth URL

use_ocr
boolean | null

Enable OCR for files that support it. Supported formats: pdf

parse_pdf_tables_with_ocr
boolean | null
enable_file_picker
boolean
default: true

Enable integration's file picker for sources that support it. Supported sources: ONEDRIVE, BOX, GOOGLE_DRIVE, DROPBOX, SHAREPOINT

Response

200 - application/json
oauth_url
string
required