Skip to main content
PATCH
Update a Cast card

Authorizations

Authorization
string
header
required

A Voyager API key from https://voyager.so/dashboard/api.

Path Parameters

cast_id
string
required

Body

application/json
expected_version
integer
required

The version you read; a stale one is 409 version_conflict.

Required range: x >= 1
name
string | null

A new display name.

Required string length: 1 - 120
kind
enum<string> | null

A new kind.

Available options:
character,
location,
prop
style
enum<string> | null

A new style.

Available options:
photoreal,
stylized
description
string | null

A new description.

Maximum string length: 600
references
ReferenceIn · object[] | null

Replaces every reference when given.

Maximum array length: 8
slug
string | null

A new slug.

Maximum string length: 48
voice_id
string | null

Send null to clear.

Maximum string length: 64

Response

Successful Response

id
string
required

cst_… Pass in input.cast (up to 4) on a job.

slug
string
required

A short handle for this Cast card, unique in the workspace.

name
string
required

The card's display name.

kind
enum<string>
required

What this Cast card is: a character, a location or a prop.

Available options:
character,
location,
prop
style
enum<string>
required

How references render: photoreal or stylized.

Available options:
photoreal,
stylized
description
string
required

What the card shows; prefixed to the prompt of jobs that feature it.

version
integer
required

Increases on every change; pass it as expected_version to change it safely.

voice_id
string | null
required

A voice for this character, when set.

references
CastReference · object[]
required

The card's reference images, in order.

object
string
default:cast

Always "cast".

Allowed value: "cast"
created_at
string<date-time> | null

When it was created (ISO 8601).

updated_at
string<date-time> | null

When it last changed (ISO 8601).