Scripts

Share a table read.

Create — or reuse — ONE screenplay version's (scriptUploadId) table-read share link: a public, signed URL that plays (theater) or streams (audio) the read. The body is optional; with none it is a public whole-read theater share for the studio's 30-day window. Pass audience (public, private_review, team), includeOnProfile, expiresInDays (1–365) or a descriptor (mode theater|audio, scope whole|scene|entries|conversation, sceneIndex, startEntry/endEntry, conversationId) to shape it. Pass tableReadJobId to share an exact read; omitted, the script's newest read WITH voices is used. A create identical to the script's active link reuses that link unchanged; ANY difference mints a new link and leaves the sent one alone, so a sent URL never silently re-scopes — no Idempotency-Key. A script with no performed read is 400 validation_failed; a script that is not yours is 404. Free: a theater MP4 renders only when asked, an audio share's scoped MP3 renders by itself. The same write the Writers Lab's share dialog, MCP share_script and sleeperhit script share create make.

post/scripts/{scriptUploadId}/share

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/scripts/{scriptUploadId}/share
  • Auth: HTTP bearer

Request body

audience'public' | 'private_review' | 'team'

Who can use the link. Default public.

includeOnProfileboolean

Show the share on the writer's public profile (only honored for a public share). Default false.

expiresInDaysinteger

How long the link works, in days. Default 30.

Response

The share link, created or reused.

scriptUploadIdstring required
jobIdstring required
shareUrlstring required

The public, signed watch/listen URL.

dashboardPathstring required

The Writers Lab path the owner opens to manage the share.

dashboardUrlstring required

Changes

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