Document Transfer

Export documents (async)

Changed on

Submit an async export of a bank's documents (extracted facts, entity names, causal links, chunks) as a transfer ZIP archive. Embeddings and database ids are not included — importing re-embeds with the target bank's model and re-resolves entities. Runs as a background operation to avoid pinning the API on large banks. Returns an operation_id; poll GET /v1/default/banks/{bank_id}/operations/{operation_id}. On completion the operation's result_metadata carries download_url (fetch the ZIP from GET /v1/default/files/download/{key}), storage_key, byte_size, and filename. Pass document_id query params to export specific documents, or omit to export the whole bank; include_observations=true carries consolidated observations and include_knowledge_base=true carries Mental Models plus Knowledge Pages (all whole-bank export only).

post/v1/default/banks/{bank_id}/document-transfer/export

Request

Path parameters

bank_idstring required

Query parameters

document_idstring[] nullable

Document id(s) to export; omit for all

include_observationsboolean

Also export consolidated observations (restored on import; whole-bank only)

include_knowledge_baseboolean

Also export Mental Models and Knowledge Pages (restored on import; whole-bank only)

Headers

authorizationstring nullable

Response

Successful Response

operation_idstring required
statusstring

Changes