Plans

Approve a generated StoryPlan.

Mandatory human approval boundary. After showing the complete generated plan to the user, send userConfirmed=true to transition it to APPROVED. Valid only from REQUIRES_APPROVAL or READY. Requires Idempotency-Key; re-approving an already-approved plan is a no-op but still requires confirmation in the request. The one exception is a show's STANDING APPROVAL: the API key it is bound to may omit userConfirmed for a table-read plan in that show's project created after the grant (not a season-run plan, not while the show is paused or archived). Every other caller still needs it.

post/story-plans/{planId}/approve

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-plans/{planId}/approve
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

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

Request body

userConfirmedtrue

Assert only after the user explicitly reviews and approves this exact StoryPlan.

Response

Approved plan.

Changes

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