Projects

Copy a product Bible persona into the cast (free).

A product project holds a cast once it has a story film. Its Bible's personas are the buyers it serves, never cast members: this COPIES one into the cast canon as a person a story film can put on screen. The persona stays in the Bible. The copy's look starts from the persona's appearance and wardrobe when the Bible has them. Someone already on the cast under the name only learns the aliases (alreadyCast: true). Refused: 409 cast_precondition_failed (reason product_cast_needs_story_film) when the product has no story film yet; 409 project_not_product on a story project; 404 character_not_found for a persona the Bible does not have. Requires Idempotency-Key. Scope: story:write.

post/story-projects/{projectId}/cast-canon/from-persona

Request

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

Headers

Idempotency-Keystring required

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

Request body

personastring required

The persona's id in the product Bible ("persona-nora") or its name.

namestring

The name to cast them under. Omitted: the persona's name without the role in brackets.

aliasesstring[]

Other names they answer to, the film's cue among them ("NORA").

Response

The person the persona was copied into.

projectIdstring required
alreadyCastboolean required

Someone on the cast already answered to the name; nobody new was added.

notestring required

Changes

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