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.
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
Response
The show as it now reads.
Changes
No recorded changes to this operation across all 2 revisions of this API.