Update Dynamic Variables

PATCH

https://api.speechify.ai/v1/agents/:id/variables

PATCH

/v1/agents/:id/variables

$ curl -X PATCH https://api.speechify.ai/v1/agents/id/variables \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "variables": [
>     {
>       "key": "product_name",
>       "type": "string",
>       "default": null,
>       "description": "Product the agent is supporting."
>     },
>     {
>       "key": "support_tier",
>       "type": "number",
>       "default": null
>     },
>     {
>       "key": "account_metadata",
>       "type": "json",
>       "description": "Arbitrary account context injected into tool bodies."
>     }
>   ]
> }'

1 {
2   "variables": [
3     {
4       "key": "string",
5       "type": "string",
6       "default": null,
7       "description": "string"
8     }
9   ],
10   "system_variables": [
11     {
12       "key": "string",
13       "description": "string"
14     }
15   ]
16 }

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 your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

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.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error