Skip to main content

​
Introduction

microfeed provides a comprehensive API that allows you to use it as a headless CMS or integrate with external services like Zapier. You can programmatically create, update, and delete items, as well as manage your channel metadata.

​
API Types

microfeed offers two distinct API types to serve different use cases:

Feed API

Public, read-only endpoints for fetching content

Admin API

Authenticated endpoints for full CRUD operations

​
Feed API

The Feed API provides read-only access to your microfeed content. These endpoints are public and don’t require authentication, making them perfect for:
  • Displaying your feed on external websites
  • Building custom frontends
  • Syndicating content to other platforms
  • Creating RSS readers or aggregators
Feed API endpoints can be disabled in your admin settings at /admin/settings/ by toggling the “Visible” option for “JSON” in the “Subscribe methods” section.
Available endpoints:
  • GET /json - Fetch the complete feed with channel metadata and items
  • GET /i/{id}/json - Fetch a single item by ID

​
Admin API

The Admin API provides full control over your microfeed instance. These endpoints require authentication and enable you to:
  • Create, update, and delete items
  • Update channel metadata
  • Upload media files to R2 storage
  • Manage your content programmatically
All Admin API endpoints require authentication using an API key. Learn more in the Authentication guide.
Available endpoints:
  • PUT /api/channels/primary/ - Update channel metadata
  • POST /api/items/ - Create a new item
  • PUT /api/items/{id}/ - Update an existing item
  • DELETE /api/items/{id}/ - Delete an item
  • GET /api/items/{id}/ - Fetch an item (authenticated version)
  • GET /api/feed/ - Fetch the feed (authenticated version)
  • POST /api/media_files/presigned_urls/ - Get presigned URL for uploading media files

​
Base URL

All API requests are made to your microfeed instance URL. The base URL format is: 
https://your-microfeed-instance.com
For example, if your microfeed is hosted at https://podcast.example.com, your API endpoints would be:
  • Feed API: https://podcast.example.com/json
  • Admin API: https://podcast.example.com/api/items/

​
Response Format

All API responses follow the JSON Feed format (version 1.1) for feed and item data. This standardized format ensures compatibility with a wide range of feed readers and tools. The response includes:
  • Standard JSON Feed fields (title, description, items, etc.)
  • microfeed-specific extensions under the _microfeed field
  • Support for various content types (audio, video, images, documents, external URLs)

​
Use Cases

Here are some common scenarios where the microfeed API shines:

Headless CMS

Use microfeed as a backend for your custom website or mobile app

Automation

Integrate with Zapier, IFTTT, or custom scripts to automate content publishing

Multi-platform Publishing

Publish content to multiple platforms simultaneously

Custom Integrations

Build custom tools and integrations for your workflow

​
Next Steps

Authentication

Learn how to authenticate your API requests

Build docs developers (and LLMs) love

Get started for freeTalk to us