Skip to main content
POST
deploy 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

Response

ok.

one config snapshot in an agent's history.

id
string<uuid>
required
versionNumber
integer
required

1 for the first deploy, counting up. a draft carries the number of the version it derives from.

status
enum<string>
required

draft (pending, not served), active (what the agent answers with) or archived.

Available options:
draft,
active,
archived
systemInstruction
string
required
greeting
string
required
ttsConfig
AgentTtsConfig · object
required

the voice an agent speaks with.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
callSettings
AgentCallSettings · object

call behaviour, versioned with the rest of the config.

name
string | null

the version's name, or null (the dashboard shows v{versionNumber}).

language
string | null
activatedAt
string<date-time> | null

when the version first went live; null for a version never deployed.