Skip to navigation

Compose a document into a branded PDF

View as Markdown

Renders the markdown through a style profile and files the PDF back onto the session as its own artifact, beside the markdown it came from. styleProfileId picks a Brand profile, configId a /v1 compose template; with neither, the org default profile is used, or the platform’s plain layout when the org has none. 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

Request

This endpoint expects an object.
styleProfileIdstringOptional1-128 characters
configIdstringOptional1-128 characters

Response

The composed PDF artifact.
dataobject

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error