Projects

Render candidate mood board frames (metered — TWO CALLS, price first).

Draw candidate frames for the project's look from a brief. METERED: one still image per frame. Sent WITHOUT confirmed it prices the batch and renders nothing (quotedOnly: true, credits, and a note to show the writer); sent again with confirmed: true it reserves the credit lines and queues the batch. confirmed is optional rather than a required true because a field that must be true to validate cannot tell a confirmed call from an unconfirmed one, and it would force the price to be announced after the money moved. EVERY CANDIDATE COSTS, KEPT OR NOT — keeping is the free act that agrees the look, so the frames the writer drops were still drawn and still charged; the quote says so and a caller showing the price must show that sentence with it. Preconditions run above the price: a project that has not passed premise coverage, or no image model bound for frames, is 409 project_precondition_failed with nothing quoted. A confirmed call answers with a chatToolJobId — the frames are NOT in the response. Poll getProjectMoodBoard until the batch leaves renders and its frames appear in candidates, then keep the ones that are right.

post/story-projects/{projectId}/mood-board/render-frames

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-projects/{projectId}/mood-board/render-frames
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

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

Request body

briefstring required

What this batch should show, in the writer's terms — a place, a light, a texture, a weather.

countinteger

How many candidates to draw. Defaults to 2; the cap is the board's cap. EACH ONE COSTS.

aspectRatiostring

Frame shape, e.g. "16:9". Defaults to the show's widescreen.

confirmedboolean

Omit (or false) to PRICE the batch and render nothing. True only after the writer has seen that price and said go.

Response

The price (no confirmed) or the queued batch.

quotedOnlyboolean required

true when this call only PRICED the batch: nothing reserved, nothing queued.

projectIdstring required
countinteger required
briefstring required
modelIdstring required

The bound image model the frames would come from.

creditsinteger required
costLabelstring nullable

Quote only.

balanceAfterinteger

Quote only. Studio Credits the writer would have left once this is spent: the balance available now (as Billing shows it) minus the price. Negative means they are that many short.

sufficientboolean

Quote only. True when the available balance covers the price. False means the writer must top up first (the note names the Billing link) — do not confirm; the reserve would refuse.

notestring

Quote only — the price, what it would leave (or how short the writer is, with the top-up link), and that unkept frames still cost. Show it to the writer.

queuedboolean

Confirmed calls only.

chatToolJobIdstring

Confirmed calls only. Poll getProjectMoodBoard until this batch leaves renders and its frames appear in candidates.

messagestring

Confirmed calls only.

Changes

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