Podcast

Each workspace has one podcast. ShortSync takes the audio from a video, hosts it and publishes an audio feed (for Spotify, Amazon Music and most podcast apps) and a video feed (for Apple Podcasts). Podcast hosting is in beta: these endpoints answer 403 PODCAST_NOT_AVAILABLE until it's turned on for the key's creator, and 404 NO_PODCAST before the show is set up on the Podcast tab. See Podcast hosting for how it works in the app. Clients in a workspace can manage episodes only with upload and scheduling access, and can't move a podcast.

Base path: https://api.shortsync.app/v1

EndpointMethodPathScopePurpose
Get the podcastGET/podcastposts:readShow details, feed URLs, readiness, podcast apps
List episodesGET/podcast/episodesposts:readEvery episode, newest first
Add an episodePOST/podcast/episodesposts:writePublish, schedule or draft a video as an episode
Update an episodePATCH/podcast/episodes/{episode_id}posts:writeTitle, notes, numbering, status or time
Delete an episodeDELETE/podcast/episodes/{episode_id}posts:writeRemove it from the feed and storage
Preview a movePOST/podcast/import/previewposts:writeWhat moving an existing podcast brings over
Move a podcastPOST/podcast/importposts:writeCopy the show and every episode here
Check the redirectGET/podcast/import/redirectposts:readIs the old feed redirecting here?

Get the podcast

GET/podcast·posts:read

Submit feed_url to Spotify, Amazon Music and other podcast apps, and video_feed_url to Apple Podcasts. is_ready is false until the title, description, owner email, category and cover are set; missing lists what isn't. directories lists the podcast apps seen reading the feed, with the first and last time.

bash
curl https://api.shortsync.app/v1/podcast \
  -H "Authorization: Bearer $TOKEN"

Example podcast

json
{
  "id": "5d2a9c1e-3b4f-4a6d-8e7c-0f1a2b3c4d5e",
  "title": "Training Notes",
  "description": "Short, practical episodes on strength training.",
  "author": "Alex Rivera",
  "owner_name": "Alex Rivera",
  "owner_email": "podcast@example.com",
  "language": "en",
  "category": "Health & Fitness",
  "subcategory": "Fitness",
  "explicit": false,
  "website_url": "https://example.com",
  "artwork_url": "https://media.shortsync.app/podcasts/5d2a9c1e/cover.jpg",
  "feed_url": "https://www.shortsync.app/api/podcasts/k3x9a2/feed.xml",
  "video_feed_url": "https://www.shortsync.app/api/podcasts/k3x9a2/video.xml",
  "description_footer": null,
  "link_original_post": false,
  "youtube_playlist_id": null,
  "podcast_index_url": null,
  "imported_from_url": null,
  "redirect_verified_at": null,
  "is_ready": true,
  "missing": [],
  "directories": [
    {
      "app": "spotify",
      "feed": "audio",
      "first_seen_at": "2026-11-02T08:14:00.000Z",
      "last_seen_at": "2026-11-19T06:40:00.000Z"
    }
  ],
  "created_at": "2026-10-30T12:00:00.000Z"
}

List episodes

GET/podcast/episodes·posts:read

Returns { data: Episode[], feed_limit }, newest first. status is processing (audio being extracted), draft, published or failed; a published episode with a future publish_at is scheduled. upload_id is the upload (its id in GET /uploads) it was made from. feed_limit is how many published episodes your plan keeps in the feed (null for no limit); older ones have outside_feed_limit true. GET /podcast/episodes/{episode_id} returns one.

Example episode

json
{
  "id": "8e1f3a5c-7b9d-4c2e-a6f8-1b3d5f7a9c2e",
  "title": "Creatine only? Here's what changed in 30 days",
  "description": "What a month of creatine did, and what it didn't.",
  "keywords": [],
  "status": "published",
  "target_status": "published",
  "error": null,
  "publish_at": "2026-11-21T07:00:00.000Z",
  "season": 1,
  "episode_number": 12,
  "duration_seconds": 412,
  "audio_url": "https://media.shortsync.app/podcasts/5d2a9c1e/8e1f3a5c.m4a",
  "video_url": null,
  "artwork_url": null,
  "upload_id": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
  "source_permalink": null,
  "from_workflow": false,
  "imported": false,
  "outside_feed_limit": false,
  "created_at": "2026-11-19T09:19:40.112Z"
}

Add an episode

POST/podcast/episodes·posts:write

Adds a video upload to the podcast and returns the episode (201) with status processing; it becomes the chosen status once the audio is ready. Only videos whose file is still stored work (400 NOT_A_VIDEO or VIDEO_FILE_GONE), and the podcast must be ready. With if_new: true, an upload that already has an episode returns it (200) instead of adding a second one. Honors Idempotency-Key.

Body

FieldTypeDescription
upload_idstringRequired. The upload's id from GET /uploads.
publishstringRequired. published (now, or at publish_at) or draft (kept out of the feed).
titlestringEpisode title. On create, defaults to the first line of the video's caption.
descriptionstringShow notes. On create, defaults to the video's caption.
season / episode_numberinteger | null1 to 9999, shown by podcast apps such as Apple Podcasts and Pocket Casts. null for none. Left out on create, the show's numbering continues.
publish_atstringISO 8601. In the future, a published episode stays out of the feed until then (scheduled). A past time means now.
if_newbooleanReturn the upload's existing episode instead of adding another.
bash
curl -X POST https://api.shortsync.app/v1/podcast/episodes \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "upload_id": "<upload-id>",
    "publish": "published",
    "publish_at": "2026-11-21T07:00:00Z"
  }'

Update an episode

PATCH/podcast/episodes/{episode_id}·posts:write

Pass any of the fields above, or status: draft takes the episode out of the feed and published puts it back. A new publish_at reschedules it. Podcast apps pick up changes at their next feed check. Returns the episode.

FieldTypeDescription
titlestringEpisode title. On create, defaults to the first line of the video's caption.
descriptionstringShow notes. On create, defaults to the video's caption.
season / episode_numberinteger | null1 to 9999, shown by podcast apps such as Apple Podcasts and Pocket Casts. null for none. Left out on create, the show's numbering continues.
publish_atstringISO 8601. In the future, a published episode stays out of the feed until then (scheduled). A past time means now.
statusstringdraft or published.

Delete an episode

DELETE/podcast/episodes/{episode_id}·posts:write

Returns 204. The episode and its audio are removed; podcast apps drop it at their next feed check. The video stays in the library.

Preview a move

POST/podcast/import/preview·posts:write

Body: { feed_url }, the podcast's RSS feed or Apple Podcasts link. Returns the show details, episode count, total size, the date range, up to 100 newest episodes and notes on anything that comes over differently. blocker says why the move can't start yet (with blocker_code), or is null. Changes nothing.

Move a podcast

POST/podcast/import·posts:write

Body: { feed_url }. Copies the show details and cover, adds every episode with its date, numbering and guid, and copies the audio in the background. Returns 201 { show, episode_count }. Listeners move once the old host permanently (301) redirects its feed to show.feed_url; don't submit the new feed to podcast apps as a new show. Honors Idempotency-Key.

Check the redirect

GET/podcast/import/redirect·posts:read

Returns { status, location, http_status }. status is redirected (the old feed permanently redirects here), wrong (it redirects elsewhere or not permanently), not_yet (the old feed still serves the show) or unreachable.

Podcast filter on uploads

GET /uploads?in_podcast=true lists only videos added to the podcast. Uploads with an episode carry podcast_episode: { id, status, publish_at, artwork_url } in GET /uploads and GET /uploads/{upload_id}.