create an agent
create an agent from a prompt, a greeting and a voice. it starts as a draft (deployed: false) — deploy it before it can take calls or be connected to a number. typing {name} into the prompt or greeting declares an account-wide variable of that name; {{tool_name}} attaches a tool. see GET /v1/voices for what ttsConfig and language (languages on a voice whose multiLanguage is true) may be.
Authorizations
your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.
Body
the body of POST /v1/agents.
the agent's name, up to 120 characters.
120the persona — what the agent is, how it behaves. up to 8000 characters. {name} reads a variable, {{tool_name}} attaches a tool. the language and voice rules are added server-side; do not write them.
8000the first thing the agent says. up to 1000 characters; may use {name} variables.
1000only for a voice whose multiLanguage is true in GET /v1/voices: the languages the agent speaks, up to 11 of that engine's languages. the call starts in the first; after that the agent replies in whichever of them the caller speaks. unset = ["english"]. on any other voice a one-item list is read as language and a longer one is refused with 400 agent_language_not_supported.
call behaviour: background_noise mixes a quiet room tone under the voice; idle_ladder nudges a silent caller and ends the call if they stay silent. both off by default.
the voice: model (muga | mulberry | spider; GET /v1/voices lists the engines your account may use), and for an engine with named voices a voice and a style description. default {"model": "muga"}.
conversation language for a single-language voice (muga, mulberry, spider) — english, hinglish or hindi (see GET /v1/voices for what each engine offers). unset = the engine's default. stored as null on a voice whose multiLanguage is true, which uses languages.
scratch (default) or template.
the template this agent was created from, when source is template.
40a name for the v1 this agent is seeded with, e.g. first cut.
120Response
created.
an agent as the account sees it: identity plus the live configuration.
the agent's UUID.
your account id.
the persona the live version answers with. a pending draft is under GET /v1/agents/{agent_ref}/versions/draft.
the live greeting.
the live voice config.
scratch or template.
the agent's short public handle (ua_…). accepted wherever an agent is named.
when the agent was created.
the last save (draft edits included).
the live call behaviour.
the live conversation language, or null for the engine's default (always null on a voice whose multiLanguage is true).
the live languages of an agent on a voice whose multiLanguage is true, first = the one a call starts in; null on every other voice.
the template it was created from, if any.
the E.164 number this agent answers (a rented number or a SIP trunk connected to it), or null.
true once a version has been deployed. until then the agent answers no calls and cannot be connected to a number.