Filter documents by metadata values
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/documents/filter-by-metadata/"
payload = { "metadata_values": ["Finance", "Legal"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({metadata_values: ['Finance', 'Legal']})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/documents/filter-by-metadata/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/documents/filter-by-metadata/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata_values": [
"Finance",
"Legal"
]
}
'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"content_type": "<string>",
"page_count": 123,
"file_size": 123,
"metadata": [
[
"<string>"
]
],
"status": "active"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Documents
Filter documents by metadata values
Retrieve documents whose metadata contains one or more of the given values (case-insensitive, OR logic).
Document metadata is stored as a list of [key, value] pairs. This endpoint matches against the
value part of each pair. For example, if a document has metadata [["category", "Finance"]],
passing metadata_values: ["finance"] will match it.
Note: This endpoint requires documents to have metadata set. See the metadata management endpoints below to add metadata to documents.
POST
/
projects
/
{project_id}
/
documents
/
filter-by-metadata
/
Filter documents by metadata values
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/documents/filter-by-metadata/"
payload = { "metadata_values": ["Finance", "Legal"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({metadata_values: ['Finance', 'Legal']})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/documents/filter-by-metadata/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/documents/filter-by-metadata/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata_values": [
"Finance",
"Legal"
]
}
'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"content_type": "<string>",
"page_count": 123,
"file_size": 123,
"metadata": [
[
"<string>"
]
],
"status": "active"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Authorizations
BearerAuthTokenAuth
Use Authorization: Bearer
Path Parameters
UUID of the project
Query Parameters
Maximum number of results per page
Required range:
1 <= x <= 1000Number of results to skip for pagination
Required range:
x >= 0Body
application/json
List of metadata values to filter by (OR logic, case-insensitive).