Files
Upload File via URL
POST
/
upload_file_from_url
Authorizations
authorization
string
headerrequiredtoken <token>
, corresponds to temporary access tokens.
Body
application/json
url
string
requiredfile_name
string | null
chunk_size
integer | null
chunk_overlap
integer | null
skip_embedding_generation
boolean
default: falseset_page_as_boundary
boolean
default: falseembedding_model
enum<string>
default: OPENAIAvailable 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
default: falseuse_textract
boolean
default: falseprepend_filename_to_chunks
boolean
default: falsemax_items_per_chunk
integer | null
Number of objects per chunk. For csv, tsv, xlsx, and json files only.
parse_pdf_tables_with_ocr
boolean
default: falsedetect_audio_language
boolean
default: falsetranscription_service
enum<string> | null
Available options:
assemblyai
, deepgram
include_speaker_labels
boolean
default: falsemedia_type
enum<string> | null
Available options:
TEXT
, IMAGE
, AUDIO
, VIDEO
split_rows
boolean
default: falsecold_storage_params
object
generate_chunks_only
boolean
default: falseIf 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.
store_file_only
boolean
default: falseIf this flag is enabled, the file will be stored with Carbon, but no processing will be done.
Response
200 - application/json
id
integer
requiredsource
enum<string>
requiredAvailable options:
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
, JPG
, PNG
, JPEG
, MP3
, MP2
, AAC
, WAV
, FLAC
, PCM
, M4A
, OGG
, OPUS
, MPEG
, MPG
, MP4
, WMV
, AVI
, MOV
, MKV
, FLV
, WEBM
, EML
, MSG
organization_id
integer
requiredorganization_supplied_user_id
string
requiredorganization_user_data_source_id
integer | null
requiredexternal_file_id
string
requiredexternal_url
string | null
requiredsync_status
enum<string>
requiredAvailable options:
DELAYED
, QUEUED_FOR_SYNC
, SYNCING
, READY
, SYNC_ERROR
, EVALUATING_RESYNC
, RATE_LIMITED
, SYNC_ABORTED
, QUEUED_FOR_OCR
, READY_TO_SYNC
sync_error_message
string | null
requiredlast_sync
string | null
requiredtags
object | null
requiredfile_statistics
object | null
requiredfile_metadata
object | null
requiredembedding_properties
object | null
requiredchunk_size
integer | null
requiredchunk_overlap
integer | null
requiredchunk_properties
object | null
requiredocr_properties
object
requiredocr_job_started_at
string | null
requiredname
string | null
requiredparent_id
integer | null
requiredenable_auto_sync
boolean | null
requiredpresigned_url
string | null
requiredparsed_text_url
string | null
requiredadditional_presigned_urls
object | null
requiredskip_embedding_generation
boolean
requiredsource_created_at
string | null
requiredgenerate_sparse_vectors
boolean | null
requiredrequest_id
string | null
requiredupload_id
string | null
requiredsync_properties
object
requiredmessages_metadata
object
requiredfile_contents_deleted
boolean
default: falserequiredsupports_cold_storage
boolean
requiredhot_storage_time_to_live
integer | null
requiredembedding_storage_status
enum<string>
requiredAvailable options:
HOT_STORAGE
, HOT_TO_COLD
, COLD_STORAGE
, COLD_TO_HOT
created_at
string
requiredupdated_at
string
required