Documents

​
Export an in-house Space document (a tab) as Markdown, HTML, Word (docx) or PDF

Returns the file. Charts export as their data table and diagrams as their connectors; sections still being written (pending) are left out. Use --output to save the file.

GET
/v1/space/documents/{document_id}/export
curl -X GET "https://api.orchestor.io/v1/space/documents/%3Cdocument_id%3E/export?format=markdown&paper=a4" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123"
// The exported file

Get your Orchestor API key

Create an API key in your workspace settings.

Authorizations

Satisfy one of these options:

  • Session cookie
  • API key

Authentication details

cookie
wos-session

Browser session established by signing in to the web app. The server checks your workspace membership and permissions. Supply X-Workspace-ID for workspace-scoped operations. For server-to-server requests, use an API key when the operation supports it.

Path Parameters

document_idstringpathrequired
Pattern
^doc_[a-f0-9]{24}$

Query Parameters

formatstringenum<string>querydefault:markdown

markdown, html, docx (Word) or pdf.

Allowed
markdownhtmldocxpdf
at_revintegerquery

Export the document as it stood at this revision (a version from the history).

Value range
≥ 1
paperstringenum<string>querydefault:a4

Page size for docx and pdf.

Allowed
a4letter

Headers

X-Workspace-IDstringheader

Workspace to access. With a workspace-scoped API key, the server derives this value from the key, so the header is optional. If supplied, it must match the credential workspace or the request returns 403 workspace_mismatch. For interactive session requests, supply this header to select a workspace where you are a member. A project ID cannot be used as a workspace ID.

Example"wks_abc123"

Response

The exported file

valuestringformat:binary