Tags
Create File Tags
A tag is a key-value pair that can be added to a file. This pair can then be used for searches (e.g. embedding searches) in order to narrow down the scope of the search. A file can have any number of tags. The following are reserved keys that cannot be used:
- db_embedding_id
- organization_id
- user_id
- organization_user_file_id
Carbon currently supports two data types for tag values - string
and list<string>
.
Keys can only be string
. If values other than string
and list<string>
are used,
they’re automatically converted to strings (e.g. 4 will become “4”).
POST
/
create_user_file_tags
Authorizations
authorization
string
headerrequiredtoken <token>
, corresponds to temporary access tokens.
Body
application/json
organization_user_file_id
integer
requiredtags
object
requiredResponse
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
, GMAIL
, OUTLOOK
, TEXT
, CSV
, TSV
, PDF
, DOCX
, PPTX
, XLSX
, MD
, RTF
, JSON
, HTML
, RAW_TEXT
, WEB_SCRAPE
, RSS_FEED
, FRESHDESK
, GITBOOK
, SALESFORCE
, GITHUB
, SLACK
, GURU
, JPG
, PNG
, JPEG
, MP3
, MP2
, AAC
, WAV
, FLAC
, PCM
, M4A
, OGG
, OPUS
, MPEG
, MPG
, MP4
, WMV
, AVI
, MOV
, MKV
, FLV
, WEBM
, EML
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
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
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