Update Dynamic Variables

from speechify import Speechify
from speechify.tts import DynamicVariable
client = Speechify(
    token="YOUR_TOKEN_HERE",
)
client.tts.agents.update_dynamic_variables(
    id="id",
    variables=[
        DynamicVariable(
            key="product_name",
            type="string",
            default="Speechify Pro",
            description="Product the agent is supporting.",
        ),
        DynamicVariable(
            key="support_tier",
            type="number",
            default=2,
            description="Support level assigned to the customer.",
        ),
        DynamicVariable(
            key="account_metadata",
            type="json",
            description="Arbitrary account context injected into tool bodies.",
        )
    ],
)

{
  "variables": [
    {
      "key": "product_name",
      "type": "string",
      "default": "Speechify Pro",
      "description": "Product the agent is supporting."
    },
    {
      "key": "support_tier",
      "type": "number",
      "default": 2,
      "description": "Support level assigned to the customer."
    },
    {
      "key": "account_metadata",
      "type": "json",
      "description": "Arbitrary account context injected into tool bodies."
    }
  ],
  "system_variables": [
    {
      "key": "system__session_id",
      "description": "Unique identifier for the current session, populated at session start."
    },
    {
      "key": "system__agent_id",
      "description": "Identifier of the agent handling the session."
    },
    {
      "key": "system__timestamp",
      "description": "ISO 8601 timestamp when the session was initiated."
    }
  ]
}

Replace the agent’s customer-scope dynamic variable definitions. The supplied list overwrites the stored list wholesale (same semantics as updateEvaluationConfig). Pass an empty array to clear all variables. Up to 20 variables per agent. Keys must match [a-zA-Z0-9_]+ and must not start with the reserved system__ prefix.

Authentication

AuthorizationBearer

Enter the key with the Bearer prefix, e.g. ‘Bearer API_KEY|ACCESS_TOKEN’.

Path parameters

idstringRequired

Request

This endpoint expects an object.

variableslist of objectsRequired

The new variable list. Replaces the existing list entirely.

Response

The updated variable catalogue.

variableslist of objects

Customer-defined variables for this agent.

system_variableslist of objects

Platform-populated system__* variables, provided for reference. This list is the same for every agent.