render_publication

readSince v1.0

Render a whole publication — every page, in reading order, in one go. This is the same assembly the PDF and the Markdown download use, so what comes back is the real artifact rather than an approximation.

Use it to review a publication end to end: what order the pages come in and how they nest, which elements made it in, and which pages came out empty. Each page carries its own diagnostics, and the result counts how many pages have any, so you can spot trouble without reading everything. When the publication has a homepage it comes first.

Results come back a page at a time. Keep calling with the next_offset from the previous result until has_more comes back false — don't drive the loop off how many you asked for, because a batch is also cut short when the text gets long. For a quick look at the shape of a large publication, ask for structure without content.

Parameters

Name	Type	Required	Default	Description
`format`	`String`	—	markdown	How to return each page: 'markdown' is the readable, diffable version; 'html' is what the viewer shows.
`locale`	`String`	—		Render the publication in this language (for example 'de').
`limit`	`Number`	—	20	How many pages to return at most in this response. Maximum 100. A batch may still come back shorter when the text gets long, so decide whether to continue from has_more rather than from this number.
`include_content`	`Boolean`	—	true	Set false to leave out the rendered text and get only the structure and diagnostics — the quickest way to check the shape of a large publication.
`publication`	`String`	✓		The publication to render, by ID, slug or name.
`offset`	`Number`	—		How many pages to skip. Pass the next_offset from the previous result to continue.

Example Request

{"publication": "service-handbook", "include_content": false, "limit": 50}

Example Response

{"total_pages": 74, "returned": 50, "has_more": true, "next_offset": 50, "pages_with_diagnostics": 3, "pages": [{"id": "homepage", "kind": "homepage", "label": "Service Handbook", "depth": 0, "diagnostics": []}]}