Projects

Pin one headshot candidate as the person's face on the cast canon.

Pins candidate candidate (1-based) of design designId as the person's headshot on the cast canon, with the prompt it was drawn from: every new episode, deck, trailer and showcase draws them from it. Free (the candidates were paid for). A NEW face clears the canon body shot and character sheet, because they were drawn from the previous face (cleared; previous keeps the old urls): draw them again with POST /story-projects/{projectId}/cast for this character. Choosing the face already pinned changes nothing. A candidate still being drawn, or that could not be drawn, is a 409 cast_precondition_failed. Requires Idempotency-Key. Scope: story:write.

post/story-projects/{projectId}/cast-portraits/choose

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-projects/{projectId}/cast-portraits/choose
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

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

Request body

designIdstring required
candidateinteger required

1-based candidate number from the design.

acknowledgeCastingCoverageboolean

Choose a headshot its casting coverage FAILED (otherwise 409 cast_portrait_casting_coverage_failed, details.castingCoverage). Send true ONLY after the writer has seen the failure and chosen it anyway.

Response

The face pinned, and what it cleared.

projectIdstring required
designIdstring required
characterstring required
clearedstring[] required

Canon pictures drawn from the previous face, cleared by the choice: draw them again with POST /story-projects/{projectId}/cast for this character.

castingCoverageWarningstring nullable

What casting coverage said about this choice: still running, could not run, another recommended, or chosen past a failure.

notestring required

Changes

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