DocumentExportId - a client-minted UUID v4, never derived from content or location.
API reference sections
Schema
DocumentExport
Type object
Shape
| Field | Type | Description |
|---|---|---|
| idrequired | DocumentExportId | |
| idempotency_keyrequired | string | |
| chat_idrequired | ChatId | ChatId - a client-minted UUID v4, never derived from content or location. |
| through_message_idrequired | MessageId | MessageId - a client-minted UUID v4, never derived from content or location. |
| destinationrequired | DocumentDestination | |
| statusrequired | ExportStatus | |
| document_id | DocumentId or null | |
| error_class | AiErrorClass or null | |
| created_atrequired | Timestamp | Epoch milliseconds, UTC. Signed, so instants before 1970 are representable. |
| completed_at | Timestamp or null |
{
"id": "00000000-0000-4000-8000-000000000000",
"idempotency_key": "string",
"chat_id": "00000000-0000-4000-8000-000000000000",
"through_message_id": "00000000-0000-4000-8000-000000000000",
"destination": {
"profile_id": "00000000-0000-4000-8000-000000000000",
"workspace_id": "00000000-0000-4000-8000-000000000000",
"parent_document_id": "00000000-0000-4000-8000-000000000000",
"index": 0,
"title": "string"
},
"status": "pending",
"document_id": "00000000-0000-4000-8000-000000000000",
"error_class": "configuration",
"created_at": 0,
"completed_at": 0
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Generated from contract version 1. Last updated .
