{ "opencollection": "1.0.0", "info": { "name": "Clarifeye Platform Agent Settings Documents API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Documents", "type": "folder" }, "items": [ { "info": { "name": "Bulk upload documents", "type": "http" }, "http": { "method": "POST", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/documents/bulk-upload/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" } ], "body": { "type": "multipart-form", "data": [ { "name": "files", "type": "text", "value": "" }, { "name": "skip_parsing", "type": "text", "value": "" } ] } }, "docs": "Upload multiple documents at once. Optionally skip the automatic parsing pipeline." }, { "info": { "name": "Delete document", "type": "http" }, "http": { "method": "DELETE", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/documents/:document_id/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "document_id", "value": "", "type": "path", "description": "UUID of the document" } ] }, "docs": "Delete a document from the project. Deletion is performed asynchronously -\nthe document is marked as \"deleting\" and removed in the background.\n" }, { "info": { "name": "List documents without file data", "type": "http" }, "http": { "method": "GET", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/documents/get-without-file/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results per page" }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip for pagination" } ] }, "docs": "Retrieve document metadata without file URLs for faster response times." }, { "info": { "name": "Filter documents by tag values", "type": "http" }, "http": { "method": "POST", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/documents/filter-by-tag/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results per page" }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip for pagination" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve documents that match one or more tag values (case-insensitive).\nPass tag values as a JSON array to avoid delimiter issues with values containing commas.\n" }, { "info": { "name": "Filter documents by metadata values", "type": "http" }, "http": { "method": "POST", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/documents/filter-by-metadata/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results per page" }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip for pagination" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve documents whose metadata contains one or more of the given values (case-insensitive, OR logic).\n\nDocument metadata is stored as a list of `[key, value]` pairs. This endpoint matches against the\n**value** part of each pair. For example, if a document has metadata `[[\"category\", \"Finance\"]]`,\npassing `metadata_values: [\"finance\"]` will match it.\n\n> **Note:** This endpoint requires documents to have metadata set. See the metadata management\n> endpoints below to add metadata to documents.\n" }, { "info": { "name": "List available document tags", "type": "http" }, "http": { "method": "GET", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/available-document-tags/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" } ] }, "docs": "Retrieve all available document tag names and their possible values for the project.\n\nValues are aggregated from both the tag extractor configuration (predefined possible values)\nand actual tag data already extracted from documents. Results are deduplicated and sorted.\n\nDocument tags are **LLM-inferred** by tag extractors during pipeline runs,\nwhereas document metadata is **user-entered** (supplied at upload time or edited\nvia the metadata endpoints).\n" }, { "info": { "name": "List available document metadata", "type": "http" }, "http": { "method": "GET", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/available-document-metadata/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" } ] }, "docs": "Retrieve all metadata keys and their distinct values across all active documents in the project.\n\nThis is useful for building filter UIs or understanding what metadata has been applied to documents.\n\nDocument metadata is **user-entered** (supplied at upload time or edited via the metadata endpoints),\nwhereas document tags are **LLM-inferred** by tag extractors during pipeline runs.\n\n> **Note:** Document metadata requires the project to use the **auto-sync** data versioning option.\n" }, { "info": { "name": "Get document tags grouped by document", "type": "http" }, "http": { "method": "GET", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/document-tags-by-document/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "document_ids", "value": "550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8", "type": "query", "description": "Comma-separated list of document UUIDs to filter by. If omitted, returns tags for all documents." }, { "name": "include_deleted_rows", "value": "", "type": "query", "description": "Whether to include soft-deleted tag rows. Defaults to false." } ] }, "docs": "Retrieve all document tags for the project, grouped by document ID.\nOptionally filter by specific document IDs.\n\nEach tag includes its name, value, and origin information (which table/row it came from).\n" }, { "info": { "name": "Add metadata to a document", "type": "http" }, "http": { "method": "POST", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/documents/:document_id/metadata-add/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "document_id", "value": "", "type": "path", "description": "UUID of the document" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a key-value metadata pair to a document. The pair is appended to the document's\nexisting metadata list.\n\nMetadata is stored as a list of `[key, value]` string pairs. A document can have\nmultiple values for the same key.\n\n> **Requires** the project to use the **auto-sync** data versioning option.\n" }, { "info": { "name": "Remove a specific metadata pair", "type": "http" }, "http": { "method": "POST", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/documents/:document_id/metadata-remove-pair/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "document_id", "value": "", "type": "path", "description": "UUID of the document" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a specific key-value pair from a document's metadata. Both key and value\nmust match exactly for the pair to be removed.\n\n> **Requires** the project to use the **auto-sync** data versioning option.\n" }, { "info": { "name": "Remove all metadata pairs for a key", "type": "http" }, "http": { "method": "POST", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/documents/:document_id/metadata-remove-key/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "document_id", "value": "", "type": "path", "description": "UUID of the document" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove all metadata pairs matching the given key from a document, regardless\nof their values.\n\n> **Requires** the project to use the **auto-sync** data versioning option.\n" }, { "info": { "name": "Get metadata values for a key", "type": "http" }, "http": { "method": "GET", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/documents/:document_id/metadata-values/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "document_id", "value": "", "type": "path", "description": "UUID of the document" }, { "name": "key", "value": "", "type": "query", "description": "The metadata key to retrieve values for" } ] }, "docs": "Retrieve all values associated with a given metadata key on a document.\n\n> **Requires** the project to use the **auto-sync** data versioning option.\n" }, { "info": { "name": "Get document indexing status", "type": "http" }, "http": { "method": "GET", "url": "https://eu.app.clarifeye.ai/api/v1/projects/:project_id/documents/indexing-status/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "document_ids", "value": "550e8400-e29b-41d4-a716-446655440000,660e8400-e29b-41d4-a716-446655440001", "type": "query", "description": "Comma-separated list of document UUIDs to filter the response.\nWhen omitted, returns statuses for all documents in the project.\n" } ] }, "docs": "Returns the indexing status for each `(document, extractor node)` pair in the project.\nCallers poll this endpoint until documents reach `active` (queryable by AI) or `deleted`.\n\n**States:**\n| Value | Meaning |\n|---|---|\n| `created` | Document saved, processing not yet started |\n| `indexing` | Processing pipeline running |\n| `ready_to_publish` | Pipeline done, waiting for publish |\n| `active` | Published to search backends — queryable by AI |\n| `failed` | Document could not be parsed; will not be" } ] } ], "bundled": true }