Files

View Files

For pre-filtering documents, using tags_v2 is preferred to using tags (which is now deprecated). If both tags_v2 and tags are specified, tags is ignored. tags_v2 enables building complex filters through the use of “AND”, “OR”, and negation logic. Take the below input as an example:

{
    "OR": [
        {
            "key": "subject",
            "value": "holy-bible",
            "negate": false
        },
        {
            "key": "person-of-interest",
            "value": "jesus christ",
            "negate": false
        },
        {
            "key": "genre",
            "value": "religion",
            "negate": true
        }
        {
            "AND": [
                {
                    "key": "subject",
                    "value": "tao-te-ching",
                    "negate": false
                },
                {
                    "key": "author",
                    "value": "lao-tzu",
                    "negate": false
                }
            ]
        }
    ]
}

In this case, files will be filtered such that:

“subject” = “holy-bible” OR
“person-of-interest” = “jesus christ” OR
“genre” != “religion” OR
“subject” = “tao-te-ching” AND “author” = “lao-tzu”

Note that the top level of the query must be either an “OR” or “AND” array. Currently, nesting is limited to 3. For tag blocks (those with “key”, “value”, and “negate” keys), the following typing rules apply:

“key” isn’t optional and must be a string
“value” isn’t optional and can be any or list[any]
“negate” is optional and must be true or false. If present and true, then the filter block is negated in the resulting query. It is false by default.

POST

user_files_v2

OrganizationUserFilesToSyncQueryInput · object

pagination

Pagination · object

limit

Limit · integer

offset

Offset · integer

order_by

OrganizationUserFilesToSyncOrderByTypes · enum<string>

order_dir

OrderDir · enum<string>

filters

OrganizationUserFilesToSyncFilters · object

source

enum<string>

name

string

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

filters.source

The source of the file. If a list is provided, the query will return files from any of the sources in the list.

Available options:

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,

JPG,

PNG,

JPEG,

MP3,

MP2,

AAC,

WAV,

FLAC,

PCM,

M4A,

OGG,

OPUS,

MPEG,

MPG,

MP4,

WMV,

AVI,

MOV,

MKV,

FLV,

WEBM,

EML

filters.name

string | null

The name of the file. The query will return files with names that contain this string.

filters.tags

object | null

deprecated

filters.tags_v2

object | null

    Tags to filter by. Supports logical AND and OR operations. Input should be like below:
    {
        "OR": [
            {
            "key": "subject",
            "value": "holy-bible",
            "negate": false
            },
            {
                "key": "person-of-interest",
                "value": "jesus christ",
                "negate": false
            },
            {
                "key": "genre",
                "value": "fiction",
                "negate": true
            }
            {
                "AND": [
                    {
                        "key": "subject",
                        "value": "tao-te-ching",
                        "negate": true
                    },
                    {
                        "key": "author",
                        "value": "lao-tzu",
                        "negate": false
                    }
                ]
            }
        ]
    }
    For a single filter, the filter block can be placed within either an "AND" or "OR" block.

filters.ids

integer[] | null

The IDs of the files. The query will return files with these IDs.

filters.external_file_ids

string[] | null

The external file IDs of the files. The query will return files with these external file IDs.

filters.sync_statuses

enum<string>[] | null

The sync statuses of the files. The query will return files with these sync statuses.

Available options:

DELAYED,

QUEUED_FOR_SYNC,

SYNCING,

READY,

SYNC_ERROR,

EVALUATING_RESYNC,

RATE_LIMITED,

SYNC_ABORTED,

QUEUED_FOR_OCR

filters.parent_file_ids

integer[] | null

deprecated

filters.organization_user_data_source_id

integer[] | null

The organization user data source IDs of the files. The query will return files with these organization user data source IDs.

filters.embedding_generators

enum<string>[] | null

The embedding generators of the files. The query will return files with these embedding generators.

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

filters.root_files_only

boolean | null

If true, the query will return only root files. Cannot be true if parent_file_ids or include_all_children is specified.

filters.include_all_children

boolean

default: false

If true, the query will return all descendents of the specified parent_file_ids.

filters.non_synced_only

boolean

default: false

If true, the query will return only files that have not been synced yet.

filters.request_ids

string[] | null

Filter by request ID(s) which were used to sync the files

filters.sync_error_message

string | null

The error message of the file. The query will return files with error messages that contain this string. To search for files with no error message, use an empty string.

filters.include_containers

boolean | null

If true, the query will return containers in the response. Containers are files that group other files together and have no content themselves. Default behavior is to include containers.

filters.external_urls

string[] | null

The external URLs of the files. The query will return files with these external URLs.

include_raw_file

boolean | null

include_parsed_text_file

boolean | null

include_additional_files

boolean | null

Response

200 - application/json

results

object[]

required

results.id

integer

required

results.source

enum<string>

required

Available options:

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,

JPG,

PNG,

JPEG,

MP3,

MP2,

AAC,

WAV,

FLAC,

PCM,

M4A,

OGG,

OPUS,

MPEG,

MPG,

MP4,

WMV,

AVI,

MOV,

MKV,

FLV,

WEBM,

EML

results.organization_id

integer

required

results.organization_supplied_user_id

string

required

results.organization_user_data_source_id

integer | null

required

results.external_file_id

string

required

results.external_url

string | null

required

results.sync_status

enum<string>

required

Available options:

DELAYED,

QUEUED_FOR_SYNC,

SYNCING,

READY,

SYNC_ERROR,

EVALUATING_RESYNC,

RATE_LIMITED,

SYNC_ABORTED,

QUEUED_FOR_OCR

results.sync_error_message

string | null

required

results.last_sync

string | null

required

results.tags

object | null

required

results.file_statistics

object | null

required

results.file_metadata

object | null

required

results.embedding_properties

object | null

required

results.chunk_size

integer | null

required

results.chunk_overlap

integer | null

required

results.chunk_properties

object | null

required

results.ocr_properties

object

required

results.ocr_job_started_at

string | null

required

results.name

string | null

required

results.parent_id

integer | null

required

results.enable_auto_sync

boolean | null

required

results.presigned_url

string | null

required

results.parsed_text_url

string | null

required

results.additional_presigned_urls

object | null

required

results.skip_embedding_generation

boolean

required

results.source_created_at

string | null

required

results.generate_sparse_vectors

boolean | null

required

results.request_id

string | null

required

results.sync_properties

object

required

results.messages_metadata

object

required

results.file_contents_deleted

boolean

default: falserequired

results.created_at

string

required

results.updated_at

string

required

count

integer

required

Upload File via URL Delete Files V2

API Documentation

Health

Auth

Files

User

Web Scrape

Data Source

Gitbook

S3

GitHub

Gmail

Slack

Outlook

Organizations

Tags

Chunks / Embeddings

Retrieval

Webhooks

View Files

Authorizations

Body

Response