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

# list variables

> every variable on the account, by name. saving an agent declares any `{name}` it types that has no row yet (with a blank default), so this list is always complete.



## OpenAPI

````yaml /openapi.json get /v1/variables
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/variables:
    get:
      tags:
        - variables
      summary: list variables
      description: >-
        every variable on the account, by name. saving an agent declares any
        `{name}` it types that has no row yet (with a blank default), so this
        list is always complete.
      operationId: listVariables
      responses:
        '200':
          description: ok.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableList'
              examples:
                default:
                  value:
                    items:
                      - id: 019f9f43-5e71-7082-bd9e-0f1a2b3c4d5e
                        name: company
                        defaultValue: acme
                        toolId: null
                        toolOutput: null
                        createdAt: '2026-09-11T10:00:00Z'
                        updatedAt: '2026-09-11T10:00:00Z'
                    count: 1
        '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
        '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:
    VariableList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Variable'
          type: array
        count:
          type: integer
      type: object
      required:
        - items
        - count
      title: VariableList
    Error:
      type: object
      properties:
        error:
          type: string
          description: human-readable error message.
        code:
          type: string
          description: machine-readable error code.
    Variable:
      properties:
        id:
          type: string
          format: uuid
          description: the variable's id.
        name:
          type: string
          description: the `{name}` prompts use.
        defaultValue:
          type: string
          description: the fallback value.
        toolId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          description: the before-call tool feeding it, or null.
        toolOutput:
          anyOf:
            - type: string
            - type: 'null'
          description: the output taken from that tool, or null.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      type: object
      required:
        - id
        - name
        - defaultValue
        - toolId
        - toolOutput
        - createdAt
        - updatedAt
      title: Variable
      description: an account-wide `{name}` prompt variable.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        your rumik api key, e.g. `rk_live_...`. create one in the rumik
        dashboard.

````