In this Guide

Uploading an Episode

To upload an episode, send a POST request to /v2/shows/SHOW-ID/episodes. The request must be authenticated, and you should replace SHOW-ID with the ID of the show where the episode should be placed. Spreaker requires that each episode belong to a show.

Example: Upload an episode

If successful, the response will contain the episode data (including the episode_id for future reference), and your episode will be immediately queued up for processing.

Processing can take anywhere from a few seconds to a few minutes, and will generate an MP3, stereo, 44.1Khz, CBR (Constant Bit-Rate) version of your audio file. Spreaker keeps both the original audio file and its re-encoded version, using the original whenever possible and only falling back to the re-encoded MP3 when the original file format is not supported by the player.

Uploading an Episode with Metadata

The API POST /v2/shows/SHOW-ID/episodes supports additional optional parameters that you can pass in order to add metadata to your episode and change the default settings:

Enable auto-sharing to social networks. The value can be a comma separated list of values: FACEBOOK, TWITTER, SOUNDCLOUD, TUMBLR, YOUTUBE (see example below).

ihr_publish

no

If false the episode will not be published on iHeart (defaults to true). This option is ignored if the episode’s show has not been submitted and approved for publishing on iHeart. Please, see Publishing an episode to iHeart for more information.

Episode Chapters also have the option of an added image per single chapter, but unfortunately images are not supported by the POST /v2/shows/SHOW-ID/episodes API. If you want to add images with each chapter, then please use the dedicated API: see Add a Chapter and Update a Chapter.

Uploading an Episode Scheduled to be Published Later

When you upload an episode it gets immediately published by default and will be public once server-side processing completes successfully. If this isn’t the desired behaviour, Spreaker gives you the option to upload an episode and schedule it to be published later.

To schedule the uploaded episode to be published later, you have to include the parameter auto_published_at in the request and set it to a future date/time. If set, the episode will not be immediately published, but will be published at the future date and time specified by auto_published_at (UTC timezone).

Example: Upload an episode scheduled to be published later

Unscheduling an Episode Scheduled to be Published Later

If the episode is scheduled to be published later and the future date / time has not been reached yet, you can switch it back to the unscheduled state by invoking the episode editing API with the parameter auto_published_atset to an empty string.