Skip to navigation
Paperwork APIWork Sessions

Compose a markdown artifact into a PDF

View as Markdown

Renders a text/markdown artifact into a PDF and files the PDF back onto the session as a new artifact, on the timeline, beside the markdown it came from.

Pass configId to render through one of your /v1/compose templates — the markdown arrives in the bundle as body.typ, which your template includes. Pass styleProfileId to render through one of your organization’s style profiles instead — including the one marked default, which this route never applies on its own. With neither, the platform’s own plain layout is used. Naming both answers 422 compose_target_ambiguous.

The source must be text/markdown; anything else answers 422 artifact_not_markdown.

Two rendering changes shipped with style profiles and apply to every call (RKO-766): CriticMarkup review comments and rejected suggestions ({>> … <<}, {-- --}) are stripped instead of printed, and GFM pipe tables render as tables instead of literal pipes.

Learn more: Work sessions

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired1-128 characters
artifactIdstringRequired1-256 characters

Request

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

Response

The composed PDF artifact.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error