Aveiro API
Authentication
Sites
List Sites
List Templates
Create Site
Pages
Create a Page
Delete a Page
List Pages
Reorder Pages
Update a Page
Site Media
Audience
Newsletter API Overview
Newsletter Campaigns
Social
Social API Overview
Social Accounts
Social Media
Social Posts
Social Performance
TrademarkTrademark
Ctrl k
Search...
Sign up
Aveiro API
Authentication
Sites
List Sites
List Templates
Create Site
Pages
Create a Page
Delete a Page
List Pages
Reorder Pages
Update a Page
Site Media
Audience
Newsletter API Overview
Newsletter Campaigns
Social
Social API Overview
Social Accounts
Social Media
Social Posts
Social Performance
Home

Aveiro API

REST API reference for automating draft content with organization-scoped bearer tokens.
Avatar
Published by Quasar 1mo ago
Sponsored
Aveiro
aveiro.app
Sponsored
Aveiro
aveiro.app
TrademarkTrademark
AveiroBlogContact
© Aveiro. All rights reserved.
Built with Aveiro
In short
The Aveiro API (/api/v1) lets CI tools and AI agents list sites, read and write draft MDX pages, manage collections, draft newsletter campaigns and social posts, and publish. Writes land in drafts by default; publishing is a separate call that requires the publish:write scope, so you can withhold it and keep publishing manual.

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)
  • Organize structure with collections and page reordering
  • Review dirty drafts before they go live
  • Publish a site, when the token carries publish:write
  • Draft newsletter campaigns and social posts for human approval
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 the Aveiro platform host: Replace the host with your own app URL when self-hosting.

Authentication

Every request requires a bearer token: Create tokens in Organization → API tokens. See Authentication for scopes and site restrictions. Scopes are granular: sites:read, sites:write, publish:write, newsletter:read, newsletter:write, audience:write and social:write. Grant only what the automation needs.

Endpoints

Guide
Method
Route
List sitesGET/api/v1/sites
Get siteGET/api/v1/sites/{siteId}
List pagesGET/api/v1/sites/{siteId}/pages
Get pageGET/api/v1/sites/{siteId}/pages/{contentId}
Get page by pathGET/api/v1/sites/{siteId}/pages/by-path?path=...
Create pagePOST/api/v1/sites/{siteId}/pages
Update pagePATCH/api/v1/sites/{siteId}/pages/{contentId}
Delete pageDELETE/api/v1/sites/{siteId}/pages/{contentId}
CollectionsGET / POST/api/v1/sites/{siteId}/collections
Reorder pagesPOST/api/v1/sites/{siteId}/reorder
Review changesGET/api/v1/sites/{siteId}/changes
Publish sitePOST/api/v1/sites/{siteId}/publish
Unpublish sitePOST/api/v1/sites/{siteId}/unpublish
List templatesGET/api/v1/templates
SubscribersPOST/api/v1/audience/subscribers
CampaignsGET / POST/api/v1/campaigns
Campaign analyticsGET/api/v1/campaigns/{campaignId}/analytics
Social postsGET / POST/api/v1/social/posts
Token infoGET/api/v1/me

Draft-first workflow

Page writes land in your draft tree, never straight onto the live site. After automation writes drafts:
  • Open the editor_url from any page response
  • Review in Visual or Source mode
  • Publish from the editor, or call POST …/publish with a publish:write token
Use GET …/changes to see which pages still have unpublished edits — this is also how an agent works incrementally instead of rewriting a site every run. Two things stay human by design: there is no route that sends a newsletter campaign, and social posts land in an approval queue rather than publishing directly.

Related

  • Authentication
  • List sites
  • Create a page
  • Update a page
  • Delete a page
  • Newsletter API overview
  • Social API overview
  • Developer overview: aveiro.app/developers
  • MCP server: aveiro.app/developers/mcp
  • Platform help: API tokens
https://www.aveiro.app/api/v1
Authorization: Bearer av_live_…