Skip to main content
PATCH
update an agent

Authorizations

Authorization
string
header
required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Path Parameters

agent_ref
string
required

the agent's UUID or its ua_… handle.

Required string length: 1 - 64

Body

application/json

the body of PATCH /v1/agents/{agent_ref} — every field optional.

callSettings
AgentCallSettings · object | null

goes to the draft.

name
string | null

renames the agent. applies immediately.

Maximum string length: 120
systemInstruction
string | null

goes to the draft.

Maximum string length: 8000
greeting
string | null

goes to the draft.

Maximum string length: 1000
ttsConfig
AgentTtsConfig · object | null

goes to the draft.

language
string | null

goes to the draft.

versionName
string | null

names the draft this edit writes. omit to leave the draft's name alone; null clears it. sent alone, renames the existing draft (409 when there is none).

Maximum string length: 120

Response

ok.

an agent as the account sees it: identity plus the live configuration.

id
string<uuid>
required

the agent's UUID.

ownerUserId
string<uuid>
required

your account id.

name
string
required
systemInstruction
string
required

the persona the live version answers with. a pending draft is under GET /v1/agents/{agent_ref}/versions/draft.

greeting
string
required

the live greeting.

ttsConfig
AgentTtsConfig · object
required

the live voice config.

source
string
required

scratch or template.

handle
string
required

the agent's short public handle (ua_…). accepted wherever an agent is named.

createdAt
string<date-time>
required

when the agent was created.

updatedAt
string<date-time>
required

the last save (draft edits included).

callSettings
AgentCallSettings · object

the live call behaviour.

language
string | null

the live conversation language, or null for the engine's default.

templateSlug
string | null

the template it was created from, if any.

inboundPhoneNumber
string | null

the E.164 number this agent answers (a rented number or a SIP trunk connected to it), or null.

deployed
boolean
default:false

true once a version has been deployed. until then the agent answers no calls and cannot be connected to a number.