import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tags-by-document/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tags-by-document/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tags-by-document/ \
--header 'Authorization: Bearer <token>'{
"550e8400-e29b-41d4-a716-446655440000": {
"tags": [
{
"tag_name": "document_type",
"tag_value": "Contract",
"origin": [
{
"id": "row-1",
"table": "table-uuid",
"table_version_id": "version-uuid"
}
]
}
]
}
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Get document tags grouped by document
Retrieve all document tags for the project, grouped by document ID. Optionally filter by specific document IDs.
Each tag includes its name, value, and origin information (which table/row it came from).
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tags-by-document/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tags-by-document/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tags-by-document/ \
--header 'Authorization: Bearer <token>'{
"550e8400-e29b-41d4-a716-446655440000": {
"tags": [
{
"tag_name": "document_type",
"tag_value": "Contract",
"origin": [
{
"id": "row-1",
"table": "table-uuid",
"table_version_id": "version-uuid"
}
]
}
]
}
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Path Parameters
UUID of the project
Query Parameters
Comma-separated list of document UUIDs to filter by. If omitted, returns tags for all documents.
Whether to include soft-deleted tag rows. Defaults to false.
true, false Response
Successful response
Map of document IDs to their tags with origin information.
Show child attributes
Show child attributes