POST
/
user_files_v2
curl --request POST \
  --url https://api.carbon.ai/user_files_v2 \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '{
  "pagination": {
    "limit": 123,
    "offset": 123
  },
  "order_by": "created_at",
  "order_dir": "desc",
  "filters": {
    "source": "GOOGLE_DRIVE",
    "name": "<string>",
    "tags": {},
    "tags_v2": {},
    "ids": [
      123
    ],
    "external_file_ids": [
      "<string>"
    ],
    "sync_statuses": [
      "DELAYED"
    ],
    "parent_file_ids": [
      123
    ],
    "organization_user_data_source_id": [
      123
    ],
    "embedding_generators": [
      "OPENAI"
    ],
    "root_files_only": true,
    "include_all_children": true,
    "non_synced_only": true,
    "request_ids": [
      "<string>"
    ]
  },
  "include_raw_file": true,
  "include_parsed_text_file": true,
  "include_additional_files": true
}'
{
  "results": [
    {
      "id": 123,
      "source": "GOOGLE_DRIVE",
      "organization_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
      },
      "file_metadata": {},
      "embedding_properties": {},
      "chunk_size": 123,
      "chunk_overlap": 123,
      "chunk_properties": {
        "set_page_as_boundary": true,
        "prepend_filename_to_chunks": true,
        "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>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123
}

Authorizations

authorization
string
headerrequired

token <token>, corresponds to temporary access tokens.

Body

application/json
pagination
object
order_by
enum<string>
Available options:
created_at,
updated_at,
name,
last_sync,
file_size,
id
order_dir
enum<string>
Available options:
desc,
asc
filters
object
include_raw_file
boolean | null
include_parsed_text_file
boolean | null
include_additional_files
boolean | null

Response

200 - application/json
results
object[]
required
count
integer
required