Draw headshot candidates for one cast member (metered — TWO CALLS, price first).
Draws N headshot candidates (candidates, default 3, at most 4) for one named cast member (character, by canon name, alias, cue or Series Bible name), so the writer chooses a face instead of taking the only one the cast draws. Each is drawn from the Series Bible's appearance and wardrobe for them with their LOOK after it: direction when given, else their look direction on the cast canon (PATCH /story-projects/{projectId}/cast-look), and age likewise. The look outranks the Bible where they differ. TWO CALLS: sent without confirmed it PRICES the candidates and draws nothing (quotedOnly: true, credits — one cast headshot per candidate — balanceAfter, sufficient, note, and the direction it will draw from); sent again with confirmed: true it reserves them, records the design and queues the draw (designId, status: queued). Poll GET .../cast-portraits/designs?designId= until status is complete. EVERY CANDIDATE DRAWN IS CHARGED, chosen or not; a candidate that cannot be drawn is released; choosing is free. RESTYLE KEEPING THE FACE: with keepFace: true each candidate is the person's CURRENT HEADSHOT on the cast canon, edited to the look (direction, else their saved look) on the model that keeps a face, so their hair, grooming, wardrobe or styling change and the person stays the same (restyledFrom names the headshot). Same price per candidate; casting coverage judges them and choosing works the same. Refused before the price: 404 character_not_found when nobody in the cast canon or Series Bible answers to the name; 409 cast_precondition_failed when there is nothing to draw them from, no image model is bound, or (with keepFace) they have no headshot yet (reason cast_face_missing) or no bound model keeps a face; 409 project_precondition_failed when the project has not reached casting. Requires Idempotency-Key. Scope: artifact:publish (billable).
Request
- Base URL: https://docs.sleeperhit.studio/api/v1
- URL: https://docs.sleeperhit.studio/api/v1/story-projects/{projectId}/cast-portraits/design
- Auth: HTTP bearer
Headers
Customer-generated stable identifier for safe retries of idempotent POST requests.
Request body
Response
The price (no confirmed) or the queued design.
Changes
No recorded changes to this operation across all 2 revisions of this API.