Filter documents by tag values
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/documents/filter-by-tag/"
payload = { "tag_values": ["<string>"] }
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({tag_values: ['<string>']})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/documents/filter-by-tag/', 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-tag/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tag_values": [
"<string>"
]
}
'{
"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>"
]
],
"collection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>"
},
"status": "active"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Documents
Filter documents by tag values
Retrieve documents that match one or more tag values (case-insensitive). Pass tag values as a JSON array to avoid delimiter issues with values containing commas.
POST
/
projects
/
{project_id}
/
documents
/
filter-by-tag
/
Filter documents by tag values
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/documents/filter-by-tag/"
payload = { "tag_values": ["<string>"] }
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({tag_values: ['<string>']})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/documents/filter-by-tag/', 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-tag/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tag_values": [
"<string>"
]
}
'{
"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>"
]
],
"collection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<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 tag values to filter by (OR logic, case-insensitive).