Shows

Set up or change a show.

The show's setup (its cast, tone, format and language live in the Series Bible and are refused here). Only the fields sent change: sources[] ({ adapter, params, label }: rss { feedUrl (required), maxItems, lookbackDays, readArticles, order }; web-search { query (required), topic, site, maxItems, lookbackDays }; hackernews { count, minComments, itemId, skipObituaries }; github { repo (required), lookbackDays }; url-watch { url (required), label }; upload { text (required), label }); schedule[] (see its own description); episodePages; episodesAtOnce (1–3, default 2: how many episodes of a run are made at once; they still publish in order); profanity (none|mild|open); punchUp (sharper jokes, with a clean first line); hardLines[] (words never said, checked across the whole script); commenterNames (handles|pseudonyms: made-up names, the default for a new show); episodeNotes (direction for the writer, ≤8,000); the planner fields, each replacing the platform's default: planningNotes[] (≤12 × 220), castNotes (≤1,000), writingStyle (≤500), objective (≤400), outcome (≤400), musicStyle (≤500), sfxPolicy (≤500); themePrompt (what the theme sounds like, ≤240); sounds[] ({ name, prompt, matches[] }, ≤24); voiceEffects[] ({ character, effect: "autotune", when: { direction }, sound? }, ≤8); memory ({ rotating[], escalating[] }); episodeCap and monthlyCap (Studio Credits; setting them takes userConfirmed: true); holdForReview (each episode waits for you to publish or drop it). A text over its cap is refused, never shortened. Example: {"sources":[{"adapter":"rss","label":"arXiv robotics","params":{"feedUrl":"https://rss.arxiv.org/rss/cs.RO"}}],"schedule":[{"every":"week","at":"07:00","weekday":"monday","covers":"roundup","episodes":1}],"episodePages":9,"profanity":"none"}. The first write on an audio series makes it a show; refused on a season run, on a video series, and (409 project_not_story) on a product project. A show that is on keeps a setup it can run on: a change that would stop it is refused, naming why.

patch/publishing-series/{seriesId}/show

Request

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

Request body

episodePagesinteger nullable

The episode length in script pages: one page is about a minute of audio (a cast of hosts runs about 1.3 minutes a page, so ~9 pages is a ~12-minute episode). 4–20. Unset, the length follows the amount of material (5–10 pages).

episodesAtOnceinteger

How many episodes of one run are made at once, 1–3 (default 2). They still publish one after another, in the order the run started them. A show's first episode is always made alone.

profanity'none' | 'mild' | 'open'
punchUpboolean

Sharper jokes, with a clean first line.

hardLinesstring[]

Words the show never says, checked across the whole script.

commenterNames'handles' | 'pseudonyms'

How the people in a thread are named: handles, or pseudonyms (made-up names, stable per show).

episodeNotesstring nullable

Direction for the writer, first in the job notes.

planningNotesstring[] nullable

What the planner must know: replaces the platform's default list.

castNotesstring nullable

Replaces the platform's cast notes for the planner.

writingStylestring nullable

Replaces the platform's writing style line.

objectivestring nullable

What an episode is for: replaces the platform's default.

outcomestring nullable

What the listener comes away with: replaces the platform's default.

musicStylestring nullable

Music direction: replaces the platform's theme line.

sfxPolicystring nullable

Sound direction: replaces the platform's sound line.

themePromptstring nullable

What the theme sounds like: the same intro and outro every episode.

episodeCapinteger nullable

The most one episode may spend, in Studio Credits. Setting it takes userConfirmed: true.

monthlyCapinteger nullable

The most a calendar month's episodes may spend, in the series' timezone. Setting it takes userConfirmed: true.

holdForReviewboolean

Each episode waits for the creator to publish or drop it.

userConfirmedboolean

Required when the call sets a cap, after the user agrees to it.

Response

The show as it now reads.

seriesIdstring required
state'not_set_up' | 'off' | 'on' | 'paused' | 'external' required
pausedReasonstring nullable required
showsRunningboolean required

False: shows aren't running across Sleeper (the operator's switch); a show made by Sleeper runs again when they do.

nextRunAtstring date-time nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.