> ## Documentation Index > Fetch the complete documentation index at: https://docs.rumik.ai/llms.txt > Use this file to discover all available pages before exploring further. # deploy an agent > put the pending draft live as the next version — the dashboard's **deploy** button. returns the version that is now active. until an agent is deployed it answers no calls (`409 agent_not_deployed` from the call endpoints) and cannot be connected to a number. ## OpenAPI ````yaml /openapi.json post /v1/agents/{agent_ref}/deploy openapi: 3.1.0 info: title: silk api version: 1.0.0 description: >- rumik ai's speech api. synthesize speech with the expressive `muga` model, the faster `mulberry` model or the multilingual `mulberry-1.6` model over http or a streaming websocket session, run conversational voice agents over webrtc, a realtime pcm socket or the phone, and manage everything the agents playground does — agents, voices, variables, tools, phone numbers, sip trunks and outbound calls — with the same api key. contact: name: rumik ai url: https://rumik.ai servers: - url: https://silk-api.rumik.ai description: production security: - bearerAuth: [] tags: - name: speech description: text-to-speech over HTTP and WebSocket. - name: voice agents description: start calls with a deployed agent from your own app. - name: agents description: build, configure, deploy and inspect your agents. - name: calls description: place outbound phone calls and read call history. - name: voices description: the voices, languages and styles an agent may use. - name: variables description: account-wide `{name}` prompt variables and their defaults. - name: tools description: HTTP tools agents call before or during a call. - name: phone numbers description: 'numbers rented through rumik: search, rent, connect, release.' - name: sip trunks description: bring your own numbers over SIP. paths: /v1/agents/{agent_ref}/deploy: post: tags: - agents summary: deploy an agent description: >- put the pending draft live as the next version — the dashboard's **deploy** button. returns the version that is now active. until an agent is deployed it answers no calls (`409 agent_not_deployed` from the call endpoints) and cannot be connected to a number. operationId: deployAgent parameters: - name: agent_ref in: path required: true schema: type: string minLength: 1 maxLength: 64 description: the agent's UUID or its `ua_…` handle. example: ua_fe3277d8 responses: '200': description: ok. content: application/json: schema: $ref: '#/components/schemas/AgentVersion' examples: default: value: id: 019f6b3f-8d2e-7c4b-af50-2b3c4d5e6f70 versionNumber: 1 name: first cut status: active systemInstruction: >- You are the support agent for {company}. Be brief and warm. When the caller asks for a human, {{transfer_call}}. greeting: Hi, this is {company} support. How can I help? ttsConfig: model: mulberry voice: Emma description: >- a female 30s american voice, normal pitch, warm timbre, conversational pacing, calm and reassuring, professional register, like a customer support agent. callSettings: background_noise: enabled: true volume: 30 idle_ladder: enabled: true nudge_after_seconds: 5 presence_after_seconds: 7 hangup_after_seconds: 5 language: english createdAt: '2026-09-11T10:00:00Z' activatedAt: '2026-09-11T10:05:00Z' updatedAt: '2026-09-11T10:05:00Z' '401': description: >- `unauthorized` — key missing, malformed, unknown, revoked or expired. content: application/json: schema: $ref: '#/components/schemas/Error' examples: unauthorized: value: error: Invalid API key code: unauthorized '403': description: '`forbidden_scope` — the key was created without the `agent` scope.' content: application/json: schema: $ref: '#/components/schemas/Error' examples: forbidden_scope: value: error: This API key lacks the 'agent' scope code: forbidden_scope '404': description: '`agent_not_found` — no such agent on this account.' content: application/json: schema: $ref: '#/components/schemas/Error' examples: agent_not_found: value: error: Agent not found code: agent_not_found '409': description: >- `agent_version_no_draft` — nothing is pending — the agent already serves its latest edits. content: application/json: schema: $ref: '#/components/schemas/Error' examples: agent_version_no_draft: value: error: This agent has no draft changes to activate code: agent_version_no_draft '429': description: >- `rate_limited` — the key's per-minute budget is spent. `Retry-After` says how long to wait; the body carries `limit` and `current`. content: application/json: schema: $ref: '#/components/schemas/Error' examples: rate_limited: value: error: Rate limit exceeded code: rate_limited limit: 100 current: 101 headers: Retry-After: description: seconds to wait before retrying (per-key rate limit only). schema: type: integer components: schemas: AgentVersion: properties: callSettings: $ref: '#/components/schemas/AgentCallSettings' id: type: string format: uuid versionNumber: type: integer description: >- 1 for the first deploy, counting up. a draft carries the number of the version it derives from. name: anyOf: - type: string - type: 'null' description: >- the version's name, or null (the dashboard shows `v{versionNumber}`). status: $ref: '#/components/schemas/AgentVersionStatus' description: >- `draft` (pending, not served), `active` (what the agent answers with) or `archived`. systemInstruction: type: string greeting: type: string ttsConfig: $ref: '#/components/schemas/AgentTtsConfig' language: anyOf: - type: string - type: 'null' createdAt: type: string format: date-time activatedAt: anyOf: - type: string format: date-time - type: 'null' description: when the version first went live; null for a version never deployed. updatedAt: type: string format: date-time type: object required: - id - versionNumber - status - systemInstruction - greeting - ttsConfig - createdAt - updatedAt title: AgentVersion description: one config snapshot in an agent's history. Error: type: object properties: error: type: string description: human-readable error message. code: type: string description: machine-readable error code. AgentCallSettings: properties: background_noise: $ref: '#/components/schemas/AgentBackgroundNoise' description: a quiet room tone mixed under the voice on every call. idle_ladder: $ref: '#/components/schemas/AgentIdleLadder' description: >- what happens when the caller goes silent after the agent stops speaking. type: object title: AgentCallSettings description: call behaviour, versioned with the rest of the config. AgentVersionStatus: type: string enum: - draft - active - archived title: AgentVersionStatus description: >- Lifecycle of one saved-agent config version. ``DRAFT`` is the single in-progress edit — every save rewrites it rather than piling up rows, and it is never what the bot serves. ``ACTIVE`` is the one version the agent currently answers with (mirrored onto ``user_agents`` so the session paths keep reading a single row). ``ARCHIVED`` is a previously active version, kept for history and rollback. AgentTtsConfig: properties: model: type: string description: >- `muga` (expressive, Hinglish-first), `mulberry` (named voices, styleable) or `spider` (speech-to-speech; no phone calls). voice: type: string description: >- mulberry only: one of the named voices in `GET /v1/voices` (e.g. `Emma`). defaults to the first. description: type: string description: >- mulberry only: a one-sentence voice style — pick one of the presets in `GET /v1/voices`, or write your own. f0_up_key: type: number description: 'mulberry only: pitch shift in semitones (-12..12).' temperature: type: number description: sampling temperature (0.1–1.5). top_p: type: number description: nucleus sampling (0–1). top_k: type: integer description: top-k sampling. repetition_penalty: type: number description: repetition penalty. max_new_tokens: type: integer description: cap on generated tokens per utterance. additionalProperties: false type: object title: AgentTtsConfig description: the voice an agent speaks with. AgentBackgroundNoise: properties: enabled: type: boolean description: mix the room tone in. volume: type: integer description: 0–100. default 30. type: object title: AgentBackgroundNoise description: A quiet room-tone bed mixed under the bot's voice on every call. AgentIdleLadder: properties: enabled: type: boolean description: turn the ladder on. nudge_after_seconds: type: integer description: >- seconds of silence before the agent says one short line to bring the caller back (1–120, default 5). presence_after_seconds: type: integer description: >- seconds after the nudge before it asks whether the caller is still there (1–120, default 7). hangup_after_seconds: type: integer description: >- seconds after that before it says goodbye and ends the call (1–120, default 5). the call's `endReason` is then `customer_ended`. type: object title: AgentIdleLadder description: 'Stale-conversation pinging: nudge → "still there?" → farewell + hang up.' securitySchemes: bearerAuth: type: http scheme: bearer description: >- your rumik api key, e.g. `rk_live_...`. create one in the rumik dashboard. ````