POST
/
integrations
/
gitbook
curl --request POST \
  --url https://api.carbon.ai/integrations/gitbook \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '{
  "organization": "<string>",
  "access_token": "<string>",
  "tags": {},
  "chunk_size": 123,
  "chunk_overlap": 123,
  "skip_embedding_generation": true,
  "embedding_model": "OPENAI",
  "generate_sparse_vectors": true,
  "prepend_filename_to_chunks": true,
  "sync_files_on_connection": true,
  "request_id": "<string>",
  "sync_source_items": true,
  "file_sync_config": {
    "auto_synced_source_types": [
      "ARTICLE"
    ],
    "sync_attachments": false,
    "detect_audio_language": false,
    "transcription_service": "assemblyai",
    "include_speaker_labels": false,
    "split_rows": false,
    "generate_chunks_only": false,
    "store_file_only": false,
    "skip_file_processing": false
  },
  "data_source_tags": {}
}'
{
  "success": true
}

Authorizations

​
authorization
string
header
required

token <token>, corresponds to temporary access tokens.

Body

application/json
​
organization
string
required
​
access_token
string
required
​
tags
object | null
​
chunk_size
integer | null
default:
1500
​
chunk_overlap
integer | null
default:
20
​
skip_embedding_generation
boolean | null
default:
false
​
embedding_model
enum<string>
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,
SOLAR_1_MINI
​
generate_sparse_vectors
boolean | null
default:
false
​
prepend_filename_to_chunks
boolean | null
default:
false
​
sync_files_on_connection
boolean | null
default:
true
​
request_id
string | null
​
sync_source_items
boolean
default:
true

Enabling this flag will fetch all available content from the source to be listed via list items endpoint

​
file_sync_config
object | null
​
data_source_tags
object

Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.

Response

200
application/json
Successful Response
​
success
boolean
required
Remove TagsGet Gitbook Spaces