POST
/
delete_user_file_tags
curl --request POST \
  --url https://api.carbon.ai/delete_user_file_tags \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '{
  "organization_user_file_id": 123,
  "tags": [
    "<string>"
  ]
}'
{
  "id": 123,
  "source": "GOOGLE_CLOUD_STORAGE",
  "organization_id": 123,
  "organization_user_id": 123,
  "organization_supplied_user_id": "<string>",
  "organization_user_data_source_id": 123,
  "external_file_id": "<string>",
  "external_url": "<string>",
  "sync_status": "DELAYED",
  "sync_error_message": "<string>",
  "last_sync": "2023-11-07T05:31:56Z",
  "tags": {},
  "file_statistics": {
    "file_format": "TXT",
    "file_size": 123,
    "num_characters": 123,
    "num_tokens": 123,
    "num_embeddings": 123,
    "mime_type": "<string>"
  },
  "file_metadata": {},
  "embedding_properties": {},
  "chunk_size": 123,
  "chunk_overlap": 123,
  "chunk_properties": {
    "set_page_as_boundary": false,
    "prepend_filename_to_chunks": false,
    "max_items_per_chunk": 123
  },
  "ocr_properties": {},
  "ocr_job_started_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "parent_id": 123,
  "enable_auto_sync": true,
  "presigned_url": "<string>",
  "parsed_text_url": "<string>",
  "additional_presigned_urls": {},
  "skip_embedding_generation": true,
  "source_created_at": "2023-11-07T05:31:56Z",
  "generate_sparse_vectors": true,
  "request_id": "<string>",
  "upload_id": "<string>",
  "sync_properties": {},
  "messages_metadata": {},
  "file_contents_deleted": false,
  "supports_cold_storage": true,
  "hot_storage_time_to_live": 123,
  "embedding_storage_status": "HOT_STORAGE",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
authorization
string
header
required

token <token>, corresponds to temporary access tokens.

Body

application/json
​
organization_user_file_id
integer
required
​
tags
string[]
required

Response

200
application/json
Successful Response
​
id
integer
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
​
organization_id
integer
required
​
organization_user_id
integer | null
required
​
organization_supplied_user_id
string
required
​
external_file_id
string
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
​
skip_embedding_generation
boolean
required
​
supports_cold_storage
boolean
required
​
embedding_storage_status
enum<string>
required
Available options:
HOT_STORAGE,
HOT_TO_COLD,
COLD_STORAGE,
COLD_TO_HOT
​
created_at
string
required
​
updated_at
string
required
​
organization_user_data_source_id
integer | null
​
external_url
string | null
​
sync_error_message
string | null
​
last_sync
string | null
​
tags
object | null
​
file_statistics
object | null
​
file_metadata
object | null
​
embedding_properties
object | null
​
chunk_size
integer | null
​
chunk_overlap
integer | null
​
chunk_properties
object | null
​
ocr_properties
object
​
ocr_job_started_at
string | null
​
name
string | null
​
parent_id
integer | null
​
enable_auto_sync
boolean | null
​
presigned_url
string | null
​
parsed_text_url
string | null
​
additional_presigned_urls
object | null
​
source_created_at
string | null
​
generate_sparse_vectors
boolean | null
​
request_id
string | null
​
upload_id
string | null
​
sync_properties
object
​
messages_metadata
object
​
file_contents_deleted
boolean
default:
false
​
hot_storage_time_to_live
integer | null
Create File TagsList Chunks and Embeddings