---
seo:
  description: >-
    Programmatic access to Jellypod podcasts, episodes, hosts, sources, and
    voices.
sidebar:
  label: Overview
title: Jellypod API
---
Programmatic access to Jellypod podcasts, episodes, hosts, sources, and voices.

Version 1.0.0

Base URL: `https://api.jellypod.com`

## Health

Service liveness checks.

- [`GET /`](/api/health/get-api-index) — API discovery index.
- [`GET /health`](/api/health/health)

## Account

Authenticated organization details.

- [`GET /v1/account`](/api/account/get-account) — Get the authenticated organization.

## Podcasts

Podcast resources.

- [`GET /v1/podcasts`](/api/podcasts/list-podcasts) — List podcasts.
- [`POST /v1/podcasts`](/api/podcasts/create-podcast) — Create a podcast.
- [`GET /v1/podcasts/{podcast_id}`](/api/podcasts/get-podcast) — Get a podcast.
- [`PATCH /v1/podcasts/{podcast_id}`](/api/podcasts/update-podcast) — Update a podcast.
- [`DELETE /v1/podcasts/{podcast_id}`](/api/podcasts/delete-podcast) — Delete a podcast.
- [`PUT /v1/podcasts/{podcast_id}/image`](/api/podcasts/update-podcast-image) — Replace the podcast cover image.

## Episodes

Episode resources.

- [`GET /v1/episodes`](/api/episodes/list-episodes) — List episodes.
- [`POST /v1/episodes`](/api/episodes/create-episode) — Create an empty episode.
- [`POST /v1/episodes/generate`](/api/episodes/generate-episode) — Generate a new episode (asynchronous).
- [`POST /v1/episodes/import`](/api/episodes/import-episode) — Import a script as a new episode.
- [`POST /v1/episodes/{episode_id}/export`](/api/episodes/export-episode) — Export saved episode content.
- [`PATCH /v1/episodes/{episode_id}`](/api/episodes/update-episode) — Update episode fields.
- [`GET /v1/episodes/{episode_id}`](/api/episodes/get-episode) — Get an episode.
- [`DELETE /v1/episodes/{episode_id}`](/api/episodes/delete-episode) — Delete an episode.
- [`PUT /v1/episodes/{episode_id}/image`](/api/episodes/upload-episode-image) — Upload an episode cover image.
- [`POST /v1/episodes/{episode_id}/publish`](/api/episodes/publish-episode) — Publish or schedule an episode.
- [`POST /v1/episodes/{episode_id}/unpublish`](/api/episodes/unpublish-episode) — Unpublish a published or scheduled episode.
- [`GET /v1/episodes/{episode_id}/timestamps`](/api/episodes/get-episode-timestamps) — Get episode timestamps.
- [`GET /v1/episodes/{episode_id}/status`](/api/episodes/get-episode-status) — Check episode generation.
- [`POST /v1/episodes/{episode_id}/retry`](/api/episodes/retry-episode) — Retry a failed episode.
- [`GET /v1/episodes/{episode_id}/download`](/api/episodes/download-episode) — Get the episode download.
- [`GET /v1/episodes/{episode_id}/video-settings`](/api/episodes/get-episode-video-settings) — Get episode captions and watermark.
- [`PATCH /v1/episodes/{episode_id}/video-settings`](/api/episodes/update-episode-video-settings) — Update episode captions and watermark.

## Analytics

Streaming and playback metrics for podcasts and episodes.

- [`GET /v1/episodes/{episode_id}/analytics`](/api/analytics/get-episode-analytics) — Get streaming analytics for an episode.
- [`GET /v1/podcasts/{podcast_id}/analytics`](/api/analytics/get-podcast-analytics) — Get streaming analytics for a podcast.

## Hosts

Host (speaker) resources.

- [`GET /v1/hosts`](/api/hosts/list-hosts) — List hosts.
- [`POST /v1/hosts`](/api/hosts/create-host) — Create a host.
- [`GET /v1/hosts/{host_id}`](/api/hosts/get-host) — Get a host.
- [`PATCH /v1/hosts/{host_id}`](/api/hosts/update-host) — Update a host.
- [`DELETE /v1/hosts/{host_id}`](/api/hosts/delete-host) — Delete a host.

## Sources

Source documents fed to generation.

- [`GET /v1/sources`](/api/sources/list-sources) — List sources.
- [`POST /v1/sources`](/api/sources/create-source) — Create a source.
- [`GET /v1/sources/{source_id}`](/api/sources/get-source) — Get a source.
- [`DELETE /v1/sources/{source_id}`](/api/sources/delete-source) — Delete a source.
- [`POST /v1/sources/uploads`](/api/sources/request-source-upload) — Request a file upload.
- [`POST /v1/sources/{source_id}/complete-upload`](/api/sources/complete-source-upload) — Complete a file upload.

## Videos

Video generation resources.

- [`GET /v1/videos/options`](/api/videos/get-video-options) — Discover video creation options.
- [`GET /v1/videos/{product_id}`](/api/videos/get-video) — Get a video.
- [`DELETE /v1/videos/{product_id}`](/api/videos/delete-video) — Delete a video.
- [`GET /v1/videos/{product_id}/status`](/api/videos/get-video-status) — Check video generation.
- [`POST /v1/videos/{product_id}/retry`](/api/videos/retry-video) — Retry a failed video.
- [`GET /v1/videos/{product_id}/download`](/api/videos/download-video) — Get the video download.
- [`GET /v1/videos/{product_id}/video-settings`](/api/videos/get-video-video-settings) — Get video captions and watermark.
- [`PATCH /v1/videos/{product_id}/video-settings`](/api/videos/update-video-video-settings) — Update video captions and watermark.
- [`GET /v1/videos`](/api/videos/list-videos) — List videos.
- [`POST /v1/videos`](/api/videos/create-video) — Create a video.

## Shorts

Short generation resources.

- [`GET /v1/shorts/options`](/api/shorts/get-short-options) — Discover short creation options.
- [`GET /v1/shorts/{product_id}`](/api/shorts/get-short) — Get a short.
- [`DELETE /v1/shorts/{product_id}`](/api/shorts/delete-short) — Delete a short.
- [`GET /v1/shorts/{product_id}/status`](/api/shorts/get-short-status) — Check short generation.
- [`POST /v1/shorts/{product_id}/retry`](/api/shorts/retry-short) — Retry a failed short.
- [`GET /v1/shorts/{product_id}/download`](/api/shorts/download-short) — Get the short download.
- [`GET /v1/shorts/{product_id}/video-settings`](/api/shorts/get-short-video-settings) — Get short captions and watermark.
- [`PATCH /v1/shorts/{product_id}/video-settings`](/api/shorts/update-short-video-settings) — Update short captions and watermark.
- [`GET /v1/shorts`](/api/shorts/list-shorts) — List shorts. Deprecated.
- [`POST /v1/shorts`](/api/shorts/create-short) — Create a short.

## Voiceovers

Voiceover generation resources.

- [`GET /v1/voiceovers/options`](/api/voiceovers/get-voiceover-options) — Discover voiceover creation options.
- [`GET /v1/voiceovers/{product_id}`](/api/voiceovers/get-voiceover) — Get a voiceover.
- [`DELETE /v1/voiceovers/{product_id}`](/api/voiceovers/delete-voiceover) — Delete a voiceover.
- [`GET /v1/voiceovers/{product_id}/status`](/api/voiceovers/get-voiceover-status) — Check voiceover generation.
- [`POST /v1/voiceovers/{product_id}/retry`](/api/voiceovers/retry-voiceover) — Retry a failed voiceover.
- [`GET /v1/voiceovers/{product_id}/download`](/api/voiceovers/download-voiceover) — Get the voiceover download.
- [`GET /v1/voiceovers/{product_id}/video-settings`](/api/voiceovers/get-voiceover-video-settings) — Get voiceover captions and watermark.
- [`PATCH /v1/voiceovers/{product_id}/video-settings`](/api/voiceovers/update-voiceover-video-settings) — Update voiceover captions and watermark.
- [`GET /v1/voiceovers`](/api/voiceovers/list-voiceovers) — List voiceovers.
- [`POST /v1/voiceovers`](/api/voiceovers/create-voiceover) — Create a voiceover.

## Voices

TTS voices.

- [`GET /v1/voices`](/api/voices/list-voices) — List voices.
- [`GET /v1/voices/{voice_id}`](/api/voices/get-voice) — Get a voice.