Skip to main content
GET
/
projects
/
{project_id}
/
document-tags-by-document
Get document tags grouped by document
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)
{
  "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"
          }
        ]
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.clarifeye.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use Authorization: Bearer

Path Parameters

project_id
string<uuid>
required

UUID of the project

Query Parameters

document_ids
string

Comma-separated list of document UUIDs to filter by. If omitted, returns tags for all documents.

include_deleted_rows
enum<string>
default:false

Whether to include soft-deleted tag rows. Defaults to false.

Available options:
true,
false

Response

Successful response

Map of document IDs to their tags with origin information.

{key}
object