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
orfalse
. If present andtrue
, then the filter block is negated in the resulting query. It isfalse
by default.
POST
/
user_files_v2
Authorizations
authorization
string
headerrequiredtoken <token>
, corresponds to temporary access tokens.
Body
application/json
pagination
object
order_by
enum<string>
default: updated_atAvailable options:
created_at
, updated_at
, name
, last_sync
, file_size
, id
order_dir
enum<string>
default: ascAvailable 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[]
requiredcount
integer
required