REST API v1

Connect RenderMark to any system that speaks HTTP

Use the REST API for scripts, services, and agents without MCP support. Every protected request uses a RenderMark API key in the Authorization header.

Quickstart

1
Create an API key
Sign in, then create a key in API key settings. Store it in a secret manager or environment variable, never in source control.
2
Use the v1 base URL
```
https://rendermark.app/api/v1
```

Send your first document

curl https://rendermark.app/api/v1/documents \
  --request POST \
  --header "Authorization: Bearer $RENDERMARK_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "title": "Release notes",
    "markdown": "# Release notes\n\nEverything shipped.",
    "publish": true
  }'

Available resources

Documents

Create, list, read, update, publish, share, embed, sync, and delete documents.

/documents/documents/:id/documents/:id/share/documents/:id/revisions/documents/:id/embed

Collections

Create ordered document collections, manage their items, and publish collection pages.

/collections/collections/:id/collections/:id/items

GitHub sync

Create a document from a GitHub Markdown file or refresh an existing linked document.

/sync/github/documents/:id/sync

Errors and limits

Errors return JSON with a stable code and readable message. Successful protected responses include rate-limit headers; limits depend on the account plan.

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "markdown is required"
  }
}