Delivery API
Your frontend reads a site's content through the read-only delivery API. It returns only published content, never drafts, and each request is authenticated with a delivery token that belongs to one site.
Everything a developer needs is in Brain > CMS > your site > Settings > For developers: the Delivery API base URL, a ready-to-use cURL example and the site's tokens.
Create a delivery token
Steps
- In the site's Settings tab, find For developers.
- In Token name, name the token after where it is used, such as
production frontend. - Click Create token.
- Copy the token and store it safely in your frontend's configuration.
Caution
The token is shown only once, when it is created. If you lose it, create a new one and revoke the old one.The token list shows when each token was last used, or never used.
Revoke a token
In For developers, click Revoke next to the token, and then confirm.
Caution
Any frontend using the token stops reading content immediately.What the API serves
All requests start from the Delivery API base URL shown in the card, in the form /api/delivery/v1/{tenant}/sites/{id}, where {tenant} is your workspace slug. Send the token in the Authorization: Bearer … header.
| Endpoint | What it returns |
|---|---|
/ | The site and its languages, with the default language. |
page?path=/about&locale=en | The published page at that path, in that language. / is the home page. |
collections/{slug}/entries?locale=en | The published entries of a collection, newest first, 12 per page by default and up to 50 with per_page. |
collections/{slug}/entries/{entrySlug} | One published entry. |
sitemap | Every published path, for each language, for pages and entries. |
media/{id} | A redirect to the file's public address. |
menus and redirects | The site's menus and redirects. |
Considerations for the delivery API
- When a request names no language, the API uses the site's default language.
- A page or entry with no published translation in the requested language is not returned. The API doesn't fall back to another language: publish every language your frontend asks for.
- A page appears in the sitemap in a language only if it and all its parent pages are published in that language.
- A token can only read its own site. Requests are rate-limited to 120 per minute from the same address.
- Menus and redirects can't be edited from Brain yet.