Content
Content
Content is what you publish on your API Portal beyond product docs: articles grouped into collections, multi-page documentation hubs, a media repository, and a portal-wide API reference for your own APIs, uploaded or composed from your products.
Content is what you publish on your API Portal beyond product documentation. You manage it in the Content group of the dashboard sidebar: articles, collections, documentation hubs, a media repository, and a portal-wide API reference for your own APIs.
What content can you publish on your API Portal?
Articles grouped into collections, multi-page documentation hubs, images and videos in a media repository, and one interactive API reference for your own APIs. Each has its own entry in the Content group.
| Content type | What it is | Availability |
|---|---|---|
| Articles and collections | Blog or news style posts, grouped into named collections. | Articles and Collections are each available on plans that include them. |
| Documentation hubs | Multi-page documentation sets with categories, pages and a sidebar. | Your plan sets how many hubs you can have, the default hub included. |
| Media Repository | Images and videos with hosted URLs you reuse across your portal. | Available on plans that include it. |
| Portal API reference | One interactive reference for your own APIs. You upload an OpenAPI file, or, on a catalog-led portal, Apiable composes it from your products' Active plans. | No separate plan requirement. |
How does Content differ from Portal pages?
Portal pages are the standalone pages of your API Portal, managed under Portal, Pages. Content covers articles, documentation hubs, media and the API reference. The two areas have separate sidebar groups and separate editors.
Portal pages and documentation hub pages are written in Markdoc, so they can use the same Markdoc components. Articles are written in a rich-text editor instead. To list articles on a portal page, you add the articles collection component to it.
Which Content features depend on your plan?
Articles, Collections and the Media Repository are each available on plans that include them. Your plan also sets how many documentation hubs you can have. The API Reference has no separate plan requirement.
| Feature | When it is not on your plan |
|---|---|
| Articles | The sidebar entry carries an upgrade marker, the page opens a Please upgrade to access this feature dialog, and the add and edit controls are disabled. |
| Collections | The same upgrade marker and dialog, and articles have no link to add them to a collection. |
| Media Repository | Add image and Add video are disabled and the upgrade dialog opens. |
| Documentation hubs | Once you reach your plan's allowance, Add another Documentation Hub is disabled and the list says you have reached the maximum. The default hub counts toward the allowance. |
In the upgrade dialog, Upgrade opens your Apiable billing, and Close returns you to the dashboard home.
Who can manage content?
The Organisation Owner, Organisation Admins and Portal Admins. Other roles can open the Content pages, but the controls that change articles, collections, documentation hubs and the API reference are disabled for them. See Members and roles.
How is the portal API reference built?
In one of two ways, decided by your portal. Until your portal is catalog-led, you upload one OpenAPI file. Once it is catalog-led, Apiable composes the reference from the APIs in your products' Active plans, and each visitor sees only the APIs they can access. See Portal API reference.
For how the API Portal fits into your API program, see API Portal.
Where to next
Articles and collections
Write articles, group them into collections, and list them on your portal.
Documentation hubs
Build multi-page documentation sets with categories and a navigation sidebar.
Media repository
Upload and manage the images and videos your portal content uses.
Portal API reference
Publish one interactive reference for your own APIs.