The Document entity manages uploaded files, their processing status, classification, and relationships to people, companies, and workspaces.Documentation Index
Fetch the complete documentation index at: https://docs.wellapp.ai/llms.txt
Use this file to discover all available pages before exploring further.
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
id | uuid, 🔒 System | — | Document identifier. Unique and idempotent |
document_type | enum | ✅ Yes | Universal Document Classification Prompt |
file_name | string | ⚪ No | Name of the document |
links.download | url, 🔒 System | — | Temporary, signed URL for file download |
file_type | string, 🔒 System | — | MIME type (e.g., application/pdf) |
size_bytes | string, 🔒 System | — | Optional file hash for dedupe |
uploaded_at | ISO 8601, 🔒 system | — | Timestamp |
processed_at | ISO 8601, 🔒 system | — | Timestamp |
deleted_at | string, 🔒 system | — | nullable ISO 8601 |
Relationships
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
persons | people | ⚪ No | People Resource associated with the document | [{ “type”: “people”, “id”: “people1” }] |
companies | to-many (company) | ⚪ No | Company Resource associated with the document | [{ “type”: “company”, “id”: “company_tenant” }] |
workspaces | to-many (workspace) | ⚪ No | Workspace Resource containing the document | [{ “type”: “workspace”, “id”: “workspace_tenant” }] |