> ## 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.

# connect a number to an agent

> connect the rented number to an agent (UUID or handle): inbound calls to the number are answered by it, and `POST /v1/calls` dials from the number for that agent. an agent answers one number, a number one agent. `agentId: null` detaches. only a deployed agent can take a number.



## OpenAPI

````yaml /openapi.json post /v1/phone-numbers/{number_id}/agent
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/phone-numbers/{number_id}/agent:
    post:
      tags:
        - phone numbers
      summary: connect a number to an agent
      description: >-
        connect the rented number to an agent (UUID or handle): inbound calls to
        the number are answered by it, and `POST /v1/calls` dials from the
        number for that agent. an agent answers one number, a number one agent.
        `agentId: null` detaches. only a deployed agent can take a number.
      operationId: connectPhoneNumberAgent
      parameters:
        - name: number_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: the rented number's id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignAgentRequest'
            examples:
              default:
                value:
                  agentId: ua_fe3277d8
      responses:
        '200':
          description: ok.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RentedNumber'
              examples:
                default:
                  value:
                    id: 019f7d21-3c5f-7e60-9b7c-8d9e0f1a2b3c
                    status: active
                    requestedNumber: '918046800123'
                    number: '918046800123'
                    e164: '+918046800123'
                    alias: null
                    numberType: local
                    countryIso: IN
                    region: Karnataka
                    city: Bangalore
                    monthlyRentalRateUsd: '2.50000'
                    setupRateUsd: '0.00000'
                    voiceRateUsd: '0.00787'
                    monthlyRentNanos: 236250000000
                    setupNanos: 0
                    voiceRateNanos: 743715000
                    outboundRateUsd: '0.01000'
                    outboundRateNanos: 945000000
                    outboundUnitSeconds: 30
                    prepaidNanos: 236250000000
                    currency: INR
                    rentedAt: '2026-09-11T10:30:00Z'
                    nextRenewalAt: '2026-10-11T10:30:00Z'
                    lastRenewalChargedFor: '2026-09-11T10:30:00Z'
                    renewalAttempts: 0
                    renewalLastError: null
                    releaseReason: null
                    releasedAt: null
                    lastError: null
                    userAgentId: 019f6a2e-7c1d-7b3a-9e4f-1a2b3c4d5e6f
                    agentName: support
                    compliance: null
                    timeline:
                      - key: prepaid
                        label: first month's rent deducted
                        state: done
                        at: '2026-09-11T10:00:05Z'
                        detail: null
                      - key: submitted
                        label: documents submitted
                        state: done
                        at: '2026-09-11T10:00:06Z'
                        detail: null
                      - key: verification
                        label: verification
                        state: done
                        at: '2026-09-11T10:25:00Z'
                        detail: null
                      - key: purchase
                        label: number purchase
                        state: done
                        at: '2026-09-11T10:30:00Z'
                        detail: null
                      - key: active
                        label: number active
                        state: done
                        at: '2026-09-11T10:30:00Z'
                        detail: null
                    events: []
                    createdAt: '2026-09-11T10:00:00Z'
                    updatedAt: '2026-09-11T10:30: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: >-
            `telephony_number_not_found` — no such rented number on this
            account. `agent_not_found` — no such agent on this account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                telephony_number_not_found:
                  value:
                    error: Phone number not found
                    code: telephony_number_not_found
                agent_not_found:
                  value:
                    error: Agent not found
                    code: agent_not_found
        '409':
          description: >-
            `telephony_number_not_active` — the rental is not in a state that
            allows this (released, or not yet purchased). `agent_not_deployed` —
            only a deployed agent (one with a live version) can answer a number
            or take a call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                telephony_number_not_active:
                  value:
                    error: This phone number is not active
                    code: telephony_number_not_active
                agent_not_deployed:
                  value:
                    error: Deploy the agent before assigning a phone number to it
                    code: agent_not_deployed
        '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:
    AssignAgentRequest:
      properties:
        agentId:
          anyOf:
            - type: string
              maxLength: 64
            - type: 'null'
          description: the agent's UUID or `ua_…` handle; `null` unassigns.
      type: object
      title: AssignAgentRequest
      description: Which agent answers a number; ``null`` detaches it.
    RentedNumber:
      properties:
        id:
          type: string
          format: uuid
          description: the rental's id.
        status:
          type: string
          description: >-
            `funding` → `kyc_submitted` → `kyc_accepted` → `purchasing` →
            `awaiting_funds` → `active`; `kyc_rejected`, `past_due`,
            `releasing`, `released`, `failed`.
        requestedNumber:
          anyOf:
            - type: string
            - type: 'null'
          description: what was asked for.
        number:
          anyOf:
            - type: string
            - type: 'null'
          description: the number owned (bare digits), once purchased.
        e164:
          anyOf:
            - type: string
            - type: 'null'
          description: the same in E.164 — what `fromNumber` on `POST /v1/calls` takes.
        alias:
          anyOf:
            - type: string
            - type: 'null'
        numberType:
          type: string
        countryIso:
          type: string
        region:
          anyOf:
            - type: string
            - type: 'null'
        city:
          anyOf:
            - type: string
            - type: 'null'
        monthlyRentalRateUsd:
          anyOf:
            - type: string
            - type: 'null'
        setupRateUsd:
          anyOf:
            - type: string
            - type: 'null'
        voiceRateUsd:
          anyOf:
            - type: string
            - type: 'null'
        monthlyRentNanos:
          anyOf:
            - type: integer
            - type: 'null'
          description: the monthly rent in the wallet's currency, in nanos (billionths).
        setupNanos:
          anyOf:
            - type: integer
            - type: 'null'
          description: one-off setup fee, nanos.
        voiceRateNanos:
          anyOf:
            - type: integer
            - type: 'null'
          description: inbound per-minute carrier rate, nanos.
        outboundRateUsd:
          anyOf:
            - type: string
            - type: 'null'
        outboundRateNanos:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            outbound per-minute carrier rate, nanos, billed per
            `outboundUnitSeconds`.
        outboundUnitSeconds:
          anyOf:
            - type: integer
            - type: 'null'
          description: the outbound billing pulse (30 s for India).
        prepaidNanos:
          type: integer
          default: 0
          description: the first charge collected before the KYC went out.
        currency:
          type: string
          description: the wallet's currency (`INR`).
        rentedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: when the number was purchased.
        nextRenewalAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: when the next month's rent is due.
        lastRenewalChargedFor:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        renewalAttempts:
          type: integer
          default: 0
        renewalLastError:
          anyOf:
            - type: string
            - type: 'null'
        releaseReason:
          anyOf:
            - type: string
            - type: 'null'
          description: why it was released (`user`, `non_payment`, …).
        releasedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        lastError:
          anyOf:
            - type: string
            - type: 'null'
          description: the last carrier or billing error, if any.
        userAgentId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          description: the agent connected to the number, or null.
        agentName:
          anyOf:
            - type: string
            - type: 'null'
          description: that agent's name.
        compliance:
          anyOf:
            - $ref: '#/components/schemas/ComplianceApplication'
            - type: 'null'
          description: >-
            the KYC application: `status`, `rejectionReason`, `attempts`,
            history.
        timeline:
          items:
            $ref: '#/components/schemas/TimelineStep'
          type: array
          description: >-
            the rental's progress, step by step: `key`, `label`, `state` (`done`
            | `active` | `pending` | `failed`), `at`, `detail`.
        events:
          items:
            additionalProperties: true
            type: object
          type: array
          description: the raw event log.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      type: object
      required:
        - id
        - status
        - numberType
        - countryIso
        - currency
        - timeline
        - events
        - createdAt
        - updatedAt
      title: RentedNumber
      description: a number rented through rumik, with its lifecycle.
    Error:
      type: object
      properties:
        error:
          type: string
          description: human-readable error message.
        code:
          type: string
          description: machine-readable error code.
    ComplianceApplication:
      properties:
        id:
          type: string
          format: uuid
        plivoComplianceId:
          anyOf:
            - type: string
            - type: 'null'
        status:
          type: string
        rejectionReason:
          anyOf:
            - type: string
            - type: 'null'
        alias:
          type: string
        endUser:
          additionalProperties: true
          type: object
        documents:
          items:
            additionalProperties: true
            type: object
          type: array
        attempts:
          type: integer
        submittedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        decidedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        history:
          items:
            additionalProperties: true
            type: object
          type: array
      type: object
      required:
        - id
        - status
        - alias
        - endUser
        - documents
        - attempts
        - history
      title: ComplianceApplication
    TimelineStep:
      properties:
        key:
          type: string
        label:
          type: string
        state:
          type: string
          enum:
            - done
            - active
            - pending
            - failed
        at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        detail:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - key
        - label
        - state
      title: TimelineStep
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        your rumik api key, e.g. `rk_live_...`. create one in the rumik
        dashboard.

````