Sign in
Logseq

Write Export To Disk

Admin-only: write a Markdown export file to disk.

This is restricted to org_admin/system_admin roles.

post/api/v1/logseq/export/write

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Headers

X-API-Keystring nullable

Request body

memory_idsstring[]

If provided, export only these memory IDs

include_short_termboolean

Include STM entries (Redis) when memory_ids are provided

scopestring nullable

Optional scope filter for LTM listing

limitinteger
export_mode'single_file' | 'vault_pages' nullable

Export mode for write-to-disk exports. single_file writes one .md file. vault_pages writes a Logseq vault structure with one page per memory. If omitted, server defaults apply.

Response

Successful Response

relative_pathstring required
bytes_writteninteger required

Changes

No recorded changes to this operation across all 2 revisions of this API.