Projects

Create a new story project workspace.

Creates an empty project, stamped with the workspace role it is made under (workspaceRole; omitted, your current role). 403 product_kind_not_for_role for kind: product from a Screenwriter account: product projects belong to Content creator and Business workspaces. Requires Idempotency-Key for safe retries.

post/story-projects

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-projects
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

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

Request body

namestring required
descriptionstring
metadataobject

Your own JSON for cross-reference, with keys the platform reads: coverageCalibrations (up to 5 names, e.g. ["comedy"]) opts this project's screenplay coverage into the series coverage calibrations an admin has written (a name with no active calibration is ignored); seasonCadence ("monthly") files new episodes by month; seasons is the project's season list. A malformed value is refused.

kind'story' | 'product'

What this project is. Omitted: the account's role default, product for a Business account and story otherwise (the ChatGPT app always starts a story). A Screenwriter account (workspace role writer) makes story projects only: product is refused with 403 product_kind_not_for_role, and omitted is always story for it. A product project's Bible carries the product block (alternatives, positioning, call to action, do-not-claim, compliance) and is judged by the product_bible rubric.

contentGuardboolean

Keep everything written for the project suitable for ages 13 and up. Default false.

medium'audio' | 'video'

What the story is made as: audio (a podcast or audio drama) saves the Series Bible's productionMedium: audio; video (for the screen) leaves the screen medium for the Bible to settle. Omitted: undecided. A product project takes neither.

recurringboolean

True: a recurring show, making new episodes on a schedule from its sources. Its show is made with the project (the read's showSeriesId), not set up and off: nothing runs or spends until its setup and caps are agreed, a preview is heard and it is turned on (/publishing-series/{seriesId}/show). Implies medium: audio. A recurring show is audio for now: make it a podcast (medium: audio) to make it recurring.

workspaceRole'writer' | 'creator' | 'business'

The workspace role to stamp the project with. Omitted: your current workspace role. With no kind, it also picks the kind (product for business, story otherwise). Every project is stamped with the workspace role it was made under (writer, creator or business): the creator's current role, or the role the create names. The sidebar's project list shows the current role's projects first, with one click to all of them. Null for a project made before roles were stamped, which shows under every role.

Response

Created project envelope.

Changes

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