POST
TypeScript client

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

personaId
string
required

Persona id (UUID), returned by list or create persona.

Body

application/json
assetId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
identityShot
enum<string>
required

Which identity view or character sheet this uploaded image represents, such as a front headshot or left profile. Assigning a new image to an occupied view replaces that view.

Available options:
character_sheet,
front_neutral,
three_quarter_left,
three_quarter_right,
profile_left,
profile_right,
front_smile,
front_talking,
full_body_back,
waist_up_hands,
full_body_front,
full_body_three_quarter
portrayedAge
integer
required

a number between 15 and 75

Required range: 15 <= x <= 75

Response

Success

personaId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
assetId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
identityShot
enum<string> | null
required
Available options:
character_sheet,
front_neutral,
three_quarter_left,
three_quarter_right,
profile_left,
profile_right,
front_smile,
front_talking,
full_body_back,
waist_up_hands,
full_body_front,
full_body_three_quarter
assignmentSource
enum<string>
required
Available options:
imported,
generated,
manual,
agent
generationId
string<uuid> | null
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
portrayedAge
integer | null
required

an integer

cameraView
enum<string> | null
required
Available options:
front,
three_quarter,
profile,
back
framing
enum<string> | null
required
Available options:
headshot,
portrait,
half_body,
full_body
isReference
boolean
required
isPrimary
boolean
required
sortOrder
integer
required

an integer

promotedAt
string | null
required
createdAt
string
required
updatedAt
string
required