Loading ...

REST API: Get Content as Markdown | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Get Content as Markdown
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 12

REST API: Get Content as Markdown

0 
 /5
0 (0votes)
Open API Guide
GET/api/content/{ContentID}/markdown

Returns a content item, found by its ContentID, as a Markdown document with its title, metadata, body, and optionally its comments. The response is the Markdown document itself (text/markdown), not JSON. When images and attachments are bundled, it is a ZIP file instead.

Request

Request Header

Header Required Value Description
Authorization YES Bearer YOUR_TOKEN Bearer token for the calling user; without it the call runs as a guest, except on a site that allows members only. Learn how to create Bearer tokens.

Required Parameters

Parameter Type Required Location Description
ContentID Integer YES Path Unique identifier for a particular content item. Supported content types: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Albums, Forums, Forum Groups, Forum Topics, Forum Posts.

Optional Parameters

Parameter Type Required Location Description
Comments Boolean NO Query Includes the content comment thread in the Markdown document. Default: false. A value other than true or false is ignored.
Download Boolean NO Query Downloads the Markdown document as an attachment. Default: false. The response then carries a Content-Disposition header naming a .md file. A ZIP is always sent as an attachment, and a value other than true or false is ignored.
Package String NO Query Controls whether related images and attachments are bundled with the document. none (default) returns Markdown only. auto bundles a ZIP only when the content has images or attachments, matching the platform's own Download Markdown behavior. zip always returns a ZIP. Any other value returns a 400 error.
AssetUrls String NO Query Controls how asset URLs are written into the document. Only raw (default) is currently supported; other values return a 400 error.
Culture String NO Query Culture (language and region) of the translation to return, such as es-ES (Spain) or en-US (United States). If that translation does not exist, the content comes back in its original language.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/content/10089/markdown

Success Response

---
title: "Quarterly Update"
type: "article"
space: "Marketing"
author: "Jane Doe"
created: 2026-09-13T01:50:16Z
updated: 2026-09-13T01:51:30Z
tags: ["example"]
url: "https://your-site.com/spaces/313/marketing/articles/noc...

Error Response

Invalid package value. Allowed values: none, auto, zip.

Error Handling

Status Code Likely Cause Next Action
400 Bad Request Package or AssetUrls carries a value other than those listed, or ContentID is not an integer. Send package as none, auto, or zip, and assetUrls as raw.
401 Unauthorized No valid Bearer token on a site that allows members only; on other sites the call runs as a guest. Check token validity. Learn how to create Bearer tokens →
404 Not Found No content has that ID, or the caller cannot view it. A permission failure is answered 404 so the endpoint does not reveal which IDs exist. The same status comes back when the caller lacks Download permission on a file, or when Markdown output is disabled on the site (ContentMarkdownEnabled). Verify the ContentID and the caller's access, and check that ContentMarkdownEnabled is on.
500 Server Error Internal failure. Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages