Shows

Make a show episode now (a preview or an extra).

Make one episode now. kind: "preview" (the default) is made from the show's sources like any episode and priced the same, held for the creator to hear and never published, and claims nothing; pass itemId to make it from one item, even one that already aired. kind: "extra", on a show made in Sleeper, goes out like any other and claims its item. A show an outside app makes takes previews only (409 show_made_outside). Two calls: without userConfirmed it quotes (nothing made); with userConfirmed: true it charges and queues. If the episode cannot be queued it is marked failed and nothing is charged (409 show_episode_not_queued; try again when the one queued finishes). Refused while the show cannot run (sources, caps), with 409 project_precondition_failed / cast_precondition_failed / show_not_ready while the project cannot make an episode, and with 409 show_cap_reached when the month cannot pay for one. Requires Idempotency-Key.

post/publishing-series/{seriesId}/show/episodes

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/publishing-series/{seriesId}/show/episodes
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Customer-generated stable identifier for safe retries of idempotent POST requests.

Request body

kind'preview' | 'extra'
itemIdstring

The item to make it from (hn:<id>, a feed entry's link, web:<url>): any item for a preview, an uncovered one for an extra.

userConfirmedboolean

Charges and queues; without it the call only quotes.

Response

Quoted, or queued.

status'quoted' | 'queued' required
quotedOnlytrue
kind'preview' | 'extra' required
itemIdstring nullable required
creditsinteger required
balanceAfterinteger required
sufficientboolean required
episodeIdstring nullable required
notestring required

Changes

No recorded changes to this operation across all 1 revision of this API.