Overview
The Podcast API turns your topic and source material into a finished, multi-speaker episode. A project moves through a simple lifecycle: create the project and its speakers, add sources, generate an outline, generate the transcript, then render the narrated audio. Finished episodes can be published to a public RSS feed for Apple Podcasts and Spotify.Authentication
- API Key (Recommended):
X-API-Key: your_api_keyheader - JWT Token:
Authorization: Bearer your_jwt_token
Lifecycle at a glance
| Step | Endpoint |
|---|---|
| 1. Create a project (+ speakers) | POST /api/v1/podcast/projects |
| 2. Add source material | POST /api/v1/podcast/projects/{id}/sources |
| 3. Generate the outline | POST /api/v1/podcast/projects/{id}/outline/generate |
| 4. Generate the transcript | POST /api/v1/podcast/projects/{id}/transcript/generate |
| 5. Estimate + render audio | GET /api/v1/podcast/projects/{id}/audio/estimate · POST /api/v1/podcast/projects/{id}/audio/generate |
| 6. Track progress | GET /api/v1/podcast/projects/{id}/progress |
| 7. Publish an RSS feed | POST /api/v1/podcast/feed |
Create a Project
- POST
- Python
title(required): Episode title (1–200 characters)topic(required): Main topic (1–500 characters)briefing(optional): Extra context / tone guidancekey_points(optional): List of points to coverlanguage(optional): Primary language code (defaulten)target_duration_minutes(optional): Target length, 5–60speakers(required): 1–4 initial speakers
Manage Projects
| Action | Request |
|---|---|
| List projects | GET /api/v1/podcast/projects |
| Get one | GET /api/v1/podcast/projects/{id} |
| Update | PUT /api/v1/podcast/projects/{id} |
| Delete | DELETE /api/v1/podcast/projects/{id} |
Update a Speaker
Change a speaker’s name or assigned voice on a project.Generate Audio
Preview the cost, then render. Audio generation follows the prepaid model — credits are reserved up front and refunded automatically on failure.GET /api/v1/podcast/projects/{id}/progress until generation completes.
Publish an RSS Feed
Turn your completed episodes into a public podcast feed you can submit to directories. The feed URL carries a signed, feed-scoped token.- POST
- Response
Next Steps
Audio Reader
Narrate a single article or block of text.
Voice Management
Browse voices or design a custom one for your hosts.
