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
orfalse
. If present andtrue
, then the filter block is negated in the resulting query. It isfalse
by default.
Authorizations
token <token>
, corresponds to temporary access tokens.
Body
Pagination parameters for the query.
The field on OrganizationUserFilesToSYnc to order the results by.
created_at
, updated_at
, name
, last_sync
, file_size
, id
The direction to order the results by.
desc
, asc
Filters to apply to the query.
If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.