Jobs

Read scene-by-scene screenplay drafting progress.

Returns the drafting job for this draft (status, completed/total scenes, current act, saved screenplay content, and the screenplay coverage started when drafting completes), or null when drafting was never started. nextStep says the state in one plain sentence, the words the editor shows: show it rather than status. Once every scene is written and coverage is in, it names Finalize, the step a Table Read waits on. Read-only.

get/screenplay-drafts/{scriptUploadId}

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/screenplay-drafts/{scriptUploadId}
  • Auth: HTTP bearer

Response

Screenplay drafting status, or null.

idstring required
statusstring required

queued, writing, interrupted (a writing lease expired), awaiting_continue (an act-first draft finished its act), paused (the screenplay changed under it), reviewing (every scene written), failed, or complete. For code: show people nextStep.

nextStepstring required

The draft's state in one plain sentence, the same words the editor shows, naming the writer's move when there is one: "Writing scene 4 of 12.", "Waiting to continue: Act 1 is written. Continue the episode to write Act 2.", "Draft saved. Coverage 8.2/10. Finalize the draft to cast it and start its Table Read."

completedScenesinteger required
totalScenesinteger required
actinteger required
totalActsinteger required
errorstring nullable
contentstring required

The saved Fountain screenplay so far.

updatedAtstring date-time required

Changes

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