Feeds
Feeds allow you to organize and distribute your pods as podcasts. On this page, we'll explore the different feed endpoints you can use to manage feeds programmatically.
The feed model
The feed model contains all the information about the feeds you create and manage in Lettercast.
Properties
- Name
id- Type
- string
- Description
Unique identifier for the feed.
- Name
title- Type
- string
- Description
The title of the feed.
- Name
description- Type
- string
- Description
A description of the feed's content.
- Name
created_at- Type
- string
- Description
The date and time when the feed was created.
- Name
lookup_key- Type
- string
- Description
Optional. A custom identifier for the feed.
- Name
slug- Type
- string
- Description
Optional. A URL-friendly version of the feed title.
List all feeds
This endpoint allows you to retrieve a list of all your feeds.
Request
export default async function handler(req, res) {
const API_KEY = process.env.LETTERCAST_API_KEY;
try {
const response = await fetch('https://app.lettercast.ai/v1/feeds', {
headers: { Authorization: `Bearer ${API_KEY}` },
});
if (!response.ok) throw new Error('API request failed');
const data = await response.json();
res.status(200).json(data);
} catch (error) {
res.status(500).json({ error: error.message });
}
}
Response
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"title": "My Tech Podcast",
"description": "Weekly discussions about technology",
"created_at": "2024-01-01T12:00:00Z",
"lookup_key": "tech-weekly",
"slug": "my-tech-podcast"
}
]
Create a feed
This endpoint allows you to create a new feed.
Required Parameters
- Name
title- Type
- string
- Description
The title of the feed.
Optional Parameters
- Name
description- Type
- string
- Description
A description of the feed's content.
- Name
lookup_key- Type
- string
- Description
A custom identifier for the feed.
- Name
slug- Type
- string
- Description
A URL-friendly version of the feed title.
- Name
feed_image_id- Type
- string
- Description
Optional. The ID of a previously uploaded feed image file. Must be a valid FEED_IMAGE file ID.
Request
// First, upload the feed image
const API_KEY = process.env.LETTERCAST_API_KEY;
const imageFile = new File(['...'], 'feed_image.jpg', { type: 'image/jpeg' });
const formData = new FormData();
formData.append('file', imageFile);
formData.append('file_type', 'FEED_IMAGE');
formData.append('filename', 'feed_image.jpg');
const uploadResponse = await fetch('https://app.lettercast.ai/v1/files', {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_KEY}`,
},
body: formData
});
if (!uploadResponse.ok) throw new Error('Failed to upload image');
const { file_id } = await uploadResponse.json();
// Then create the feed with the image ID
const feedResponse = await fetch('https://app.lettercast.ai/v1/feeds', {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
title: 'My Tech Podcast',
description: 'Weekly discussions about technology',
lookup_key: 'tech-weekly',
slug: 'my-tech-podcast',
feed_image_id: file_id
})
});
if (!feedResponse.ok) throw new Error('Failed to create feed');
const result = await feedResponse.json();
Response
{
"feed_id": "123e4567-e89b-12d3-a456-426614174000"
}
Retrieve a feed
This endpoint allows you to retrieve a specific feed by providing its ID.
The response can be returned in two formats:
- JSON (default)
- XML (RSS feed format) - request with Accept: application/xml header or .xml extension
Request
export default async function handler(req, res) {
const API_KEY = process.env.LETTERCAST_API_KEY;
const { id } = req.query;
try {
const response = await fetch(`https://app.lettercast.ai/v1/feeds/${id}`, {
headers: {
Authorization: `Bearer ${API_KEY}`,
Accept: 'application/json' // or 'application/xml' for RSS feed
},
});
if (!response.ok) throw new Error('API request failed');
const data = await response.json();
res.status(200).json(data);
} catch (error) {
res.status(500).json({ error: error.message });
}
}
JSON Response
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"title": "My Tech Podcast",
"description": "Weekly discussions about technology",
"created_at": "2024-01-01T12:00:00Z",
"lookup_key": "tech-weekly",
"slug": "my-tech-podcast"
}
Update a feed
This endpoint allows you to update an existing feed.
Optional Parameters
- Name
title- Type
- string
- Description
The new title for the feed.
- Name
description- Type
- string
- Description
The new description for the feed.
- Name
lookup_key- Type
- string
- Description
A new custom identifier for the feed.
- Name
feed_image_id- Type
- string
- Description
Optional. The ID of a previously uploaded feed image file. Must be a valid FEED_IMAGE file ID.
Request
// First, upload the new feed image if needed
const API_KEY = process.env.LETTERCAST_API_KEY;
const imageFile = new File(['...'], 'new_feed_image.jpg', { type: 'image/jpeg' });
const formData = new FormData();
formData.append('file', imageFile);
formData.append('file_type', 'FEED_IMAGE');
formData.append('filename', 'new_feed_image.jpg');
const uploadResponse = await fetch('https://app.lettercast.ai/v1/files', {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_KEY}`,
},
body: formData
});
if (!uploadResponse.ok) throw new Error('Failed to upload image');
const { file_id } = await uploadResponse.json();
// Then update the feed with the new image ID
const feedResponse = await fetch('https://app.lettercast.ai/v1/feeds/123e4567-e89b-12d3-a456-426614174000', {
method: 'PUT',
headers: {
'Authorization': `Bearer ${API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
title: 'Updated Tech Podcast',
description: 'Daily discussions about technology',
lookup_key: 'tech-daily',
feed_image_id: file_id
})
});
if (!feedResponse.ok) throw new Error('Failed to update feed');
const result = await feedResponse.json();
Response
{
"status": "success"
}