Guides

Exports

Every export carries the sources and the label. An export never approves.

On this page

Make and download#

An export is two calls: render the file, then download it with the same key. Both need the export scope and spend nothing.

curl -X POST "$BRENZURI_URL/api/v1/articles/$ARTICLE_ID/export" \
  -H "Authorization: Bearer $BRENZURI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "markdown"
  }'

JSON

{
  "url": "/api/v1/exports/6E2B0D94-7C1A-4F35-98D2-A1B3C4D5E6F7"
}

A relative path, not a signed link. It needs the same credential.

Shell

curl "$BRENZURI_URL/api/v1/exports/$EXPORT_ID" \
  -H "Authorization: Bearer $BRENZURI_KEY" \
  -OJ

The file arrives with Content-Disposition: attachment; filename="<slug>-v<n>.<ext>", so the name carries the version.

Three formats#

Target	File	What it holds
`markdown`	`text/markdown`	The article, its sources list, the evidence report as text, and the label line.
`pdf`	`application/pdf`	The evidence report as a laid-out document, with the illustration when the article has one. Needs the PDF renderer; without it the route answers 501 `not_built_yet`.
`docx`	Word document	The same evidence report as Word. The illustration’s label and caption are in it; the picture itself is not.

There is no HTML export and no JSON export. To get the article as data, read it with GET /articles/{id}; to put it on a site, deliver it.

Markdown#

In order:

The title as # title, and the deck in italics when there is one.
The illustration line and its caption, when the exported version has an illustration.
The text, with each flagged claim’s sentence left in place.
## Sources: one line per outlet, a dagger after an outlet that carries a flagged claim, then its URL, what it contributed and how it relates to another source.
The evidence report in plain text.
The label, last: _Generated with sources · reviewed by a human: no_, or yes · Approved by <name>, version v<n>.

Markdown

## Sources

- harbour-authority.example †
  https://harbour-authority.example/news/northern-route-timetable · Contributed: 2 claims
- coast-gazette.example
  https://coast-gazette.example/transport/ferries-share-timetable · Contributed: 2 claims

_Generated with sources · reviewed by a human: no_

The end of a Markdown export of an article that is not approved

The evidence report#

PDF and DOCX are the evidence report; Markdown ends with it as text. It is what an editor or a reader needs to check the article:

The title, lead and deck, and the text.
Counts of sources, independent origins, claims and corroborated claims, with the method note: independent means the sources did not copy each other, and two outlets carrying one wire report count as one origin.
The numbered sources, each with its origin, score, whether it is official, what it contributed and which flagged claim it carries.
Every flagged claim with its state, how many origins stand behind it, which outlets, and, when a person kept the flag, who kept it, when and with what note.
Superseded documents, kept and named, never removed.
The current version, the approval sentence, and the record of versions: label, time, who, which agent, which model.

The label#

Every export ends with whether a person reviewed that version. It is derived from the approval record and cannot be turned off, edited or asked for in the request. The interface has an export footer toggle that reads “reviewed by a human”; it is ignored, and the line always follows the approval record.

Workspace rules#

Before anything is rendered the workspace’s rules are checked. A workspace can require approval before export, and can block export while any claim is flagged.

Rule	Answer
Approval required, version not approved	409 `approval_required`
Block while flagged, a claim is flagged	409 `export_blocked_flagged`

Retention and events#

An export file is kept for 7 days. Deletion is lazy: old files are removed the next time the workspace makes an export, so an old address may keep working a little longer. Do not rely on either.
Each export raises article.exported with the target and the version.
Through MCP, export.render returns Markdown as text; for PDF and DOCX it only makes the file.