Upload File via URL

Authorizations

authorization

string

header

required

token <token>, corresponds to temporary access tokens.

Body

application/json

url

string

required

chunk_overlap

integer | null

chunk_size

integer | null

cold_storage_params

object

detect_audio_language

boolean

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

file_name

string | null

generate_chunks_only

boolean

default:

false

If 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.

generate_sparse_vectors

boolean

default:

false

include_speaker_labels

boolean

default:

false

max_items_per_chunk

integer | null

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

Required range: x > 0

media_type

enum<string> | null

Available options:

TEXT,

IMAGE,

AUDIO,

VIDEO

parse_pdf_tables_with_ocr

boolean

default:

false

prepend_filename_to_chunks

boolean

default:

false

set_page_as_boundary

boolean

default:

false

skip_embedding_generation

boolean

default:

false

split_rows

boolean

default:

false

store_file_only

boolean

default:

false

If this flag is enabled, the file will be stored with Carbon, but no processing will be done.

transcription_service

enum<string> | null

Available options:

assemblyai,

deepgram

use_textract

boolean

default:

false

Response

200 - application/json

created_at

string

required

embedding_storage_status

enum<string>

required

Available options:

HOT_STORAGE,

HOT_TO_COLD,

COLD_STORAGE,

COLD_TO_HOT

external_file_id

string

required

integer

required

organization_id

integer

required

organization_supplied_user_id

string

required

organization_user_id

integer | null

required

skip_embedding_generation

boolean

required

source

enum<string>

required

Available 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,

DOCUMENT360,

JPG,

PNG,

JPEG,

MP3,

MP2,

AAC,

WAV,

FLAC,

PCM,

M4A,

OGG,

OPUS,

MPEG,

MPG,

MP4,

WMV,

AVI,

MOV,

MKV,

FLV,

WEBM,

EML,

MSG

supports_cold_storage

boolean

required

sync_status

enum<string>

required

Available options:

DELAYED,

QUEUED_FOR_SYNC,

SYNCING,

READY,

SYNC_ERROR,

EVALUATING_RESYNC,

RATE_LIMITED,

SYNC_ABORTED,

QUEUED_FOR_OCR,

READY_TO_SYNC

updated_at

string

required

additional_presigned_urls

object | null

chunk_overlap

integer | null

chunk_properties

object | null

chunk_size

integer | null

embedding_properties

object | null

enable_auto_sync

boolean | null

external_url

string | null

file_contents_deleted

boolean

default:

false

file_metadata

object | null

file_statistics

object | null

generate_sparse_vectors

boolean | null

hot_storage_time_to_live

integer | null

last_sync

string | null

messages_metadata

object

name

string | null

ocr_job_started_at

string | null

ocr_properties

object

organization_user_data_source_id

integer | null

parent_id

integer | null

parsed_text_url

string | null

presigned_url

string | null

request_id

string | null

source_created_at

string | null

sync_error_message

string | null

sync_properties

object