Skip to navigation

Read a markdown document

View as Markdown

The markdown behind a text/markdown artifact, at its current version — what the editor opens at /documents/:artifactId. readOnly is true for a caller who may read the session but not write it, so the editor can say so instead of failing a save. Authorization: the same gate as every session route — work_session:read (or comment to write) on the session, OR space:contribute on one of its linked spaces; a desk session only for its owner. Any denial is 404.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

sessionIdstringRequired
artifactIdstringRequired

Response

The document.
artifactIdstring
namestring
versioninteger-9007199254740991-9007199254740991
markdownstring
readOnlyboolean
editorStatestring or nullOptional<=1000000 characters

Errors

404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error