List available document metadata

Retrieve all metadata keys and their distinct values across all active documents in the project.

This is useful for building filter UIs or understanding what metadata has been applied to documents.

Document metadata is user-entered (supplied at upload time or edited via the metadata endpoints), whereas document tags are LLM-inferred by tag extractors during pipeline runs.

Note: Document metadata requires the project to use the auto-sync data versioning option.

GET /projects/{project_id}/available-document-metadata

List available document metadata

Python

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/available-document-metadata/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "tag": [
    "Finance",
    "Legal"
  ],
  "source_path": [
    "/path/to/document.pdf",
    "/path/to/document.docx"
  ]
}

Authorizations

BearerAuthTokenAuth

Authorization · string · header · required

Use Authorization: Bearer

Path Parameters

project_id · string<uuid> · required

UUID of the project

Response

200

application/json

Successful response

Map of metadata keys to their distinct values (sorted).

{key} · string[]