Home

Aveiro API

REST API reference for automating draft content with organization-scoped bearer tokens.

Published by Quasar 1mo ago

In short

The Aveiro API (/api/v1) lets CI tools and AI agents list sites, read and write draft MDX pages, and review unpublished changes. Tokens cannot publish — you review in the editor and publish manually.

What this API is for

Use the Aveiro API when you want automation to:

List sites your token can access
Create and update draft pages (MDX content + metadata)
Delete draft pages you no longer need
Review dirty drafts before publishing in the editor

Typical workflows: docs sync from git, AI agents drafting content, internal scripts keeping help sites up to date.

Base URL

All routes live under /api/v1 on your Aveiro platform host: Replace the host with your own app URL when self-hosting or using a custom domain.

Authentication

Every request requires a bearer token: Create tokens in Organization → API tokens. See Authentication for scopes and site restrictions.

Endpoints

Guide	Method	Route
List sites	GET	/api/v1/sites
Get site	GET	/api/v1/sites/{siteId}
List pages	GET	/api/v1/sites/{siteId}/pages
Get page	GET	/api/v1/sites/{siteId}/pages/{contentId}
Get page by path	GET	/api/v1/sites/{siteId}/pages/by-path?path=...
Create page	POST	/api/v1/sites/{siteId}/pages
Update page	PATCH	/api/v1/sites/{siteId}/pages/{contentId}
Delete page	DELETE	/api/v1/sites/{siteId}/pages/{contentId}
Review changes	GET	/api/v1/sites/{siteId}/changes
Token info	GET	/api/v1/me

Draft-only workflow

The API never publishes content. After automation writes drafts:

Open the editor_url from any page response
Review in Visual or Source mode
Publish from the editor when ready

Use GET …/changes to see which pages still have unpublished edits.

Aveiro API

Aveiro API

What this API is for

Base URL

Authentication

Endpoints

Draft-only workflow

Related

What this API is for

Base URL

Authentication

Endpoints

Draft-only workflow

Related