S3
Sync S3 Files
S3
Sync S3 Files
After optionally loading the items via /integrations/items/sync and integrations/items/list, use the bucket name and object key as the ID in this endpoint to sync them into Carbon. Additional parameters below can associate data with the selected items or modify the sync behavior
POST
/
integrations
/
s3
/
files
Authorizations
authorization
string
headerrequiredtoken <token>, corresponds to temporary access tokens.
Body
application/json
ids
object[]
requiredEach input should be one of the following: A bucket name, a bucket name and a prefix, or a bucket name and an object key. A prefix is the common path for all objects you want to sync. Paths should end with a forward slash.
tags
object | null
chunk_size
integer | null
default: 1500chunk_overlap
integer | null
default: 20skip_embedding_generation
boolean | null
default: falseembedding_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: falseprepend_filename_to_chunks
boolean | null
default: falsemax_items_per_chunk
integer | null
Number of objects per chunk. For csv, tsv, xlsx, and json files only.
Required range:
x > 0set_page_as_boundary
boolean
default: falsedata_source_id
integer | null
request_id
string | null
use_ocr
boolean | null
default: falseparse_pdf_tables_with_ocr
boolean | null
default: falsefile_sync_config
object | null
Response
200 - application/json
success
boolean
required