Skip to main content
PUT
Update shared identity
The shared identity is the agent’s persona. All of its tasks speak with this name, voice, language, and instructions, including while the agent works out which task should answer.
  • A task that has its own language keeps it.
  • In channel_prompts, the agent’s instructions for a channel come first, and a task’s instructions for the same channel are added after them.
  • This is a full replacement, so send every field. To change only one, read the current values with Get settings first.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Agent ID (master_workflow in the API). A malformed ID returns 400 invalid_group_id.

Body

application/json
name
string
required
Required string length: 1 - 120
voice_id
string
required
Required string length: 1 - 255
language
enum<string>
required
Available options:
es-CL,
es-MX,
es-PE,
es-CO,
es-AR,
es-US,
en-US,
en-AU,
ko-KR,
pt-BR,
fr-FR
identity_prompt
string
required
Required string length: 1 - 8000
channel_prompts
object
required

Extra instructions per channel, up to 8,000 characters each. Send {} for none.

confirm
enum<boolean>
required

Must be true.

Available options:
true

Response

Saved identity.

agent_group_id
string<uuid>
required
identity
object | null
required

The agent's shared identity: the name, voice, language, and instructions all of its tasks speak with, including while the agent works out which task should answer. When the agent has no complete identity of its own, the values shown come from the default task.

Last modified on September 28, 2026