Artifacts

Regenerate a single character's avatar portrait on a table read artifact.

Re-renders ONE character's avatar portrait on the table read backing this table_read artifact, in place. The artifact id, share token, and all player URLs remain STABLE — no new revision, no charge, like a voice recast. Body: { character, refinement?, style?, referenceImageUrl? }. refinement is a freeform art-direction nudge; style persists an episode portrait override without changing project Series Bible canon; referenceImageUrl seeds the image model from an already-uploaded image. Async + queue-backed: enqueues a regenerate_avatar job and returns { character, status, chatToolJobId }. Poll GET /artifacts/{artifactId}/cast and watch that character's avatarStatus (queued → rendering → ready). Requires Idempotency-Key. Scope: artifact:publish.

post/artifacts/{artifactId}/avatar

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/artifacts/{artifactId}/avatar
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

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

Request body

characterstring required

Character cue whose avatar to regenerate, e.g. "NARRATOR" or "MAYA".

refinementstring

Optional freeform art-direction nudge for this render, e.g. "older, weathered, dim backlight".

stylestring

Optional explicit episode portrait override (at most 8000 characters: it is saved as the episode avatar override and takes that override's cap). It persists for subsequent renders in this episode without changing the project Series Bible. To apply it to the whole cast, use POST /artifacts/{id}/cast with avatarStyle.

referenceImageUrlstring uri

Optional already-uploaded image URL (http or https) to seed the portrait.

confirmedboolean

PRICED (three images: the headshot, and the body shot and sheet redrawn to match it; 3 credits). Omit to get the price only (quotedOnly: true, nothing drawn or charged); send true to draw and charge.

Response

Without confirmed: the price (3 credits), nothing drawn. With confirmed: true: avatar regeneration dispatched and charged. Poll GET /artifacts/{artifactId}/cast until the character's avatarStatus is ready.

OR

Changes

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