Skip to main content
POST
/
agents
/
{agentId}
/
variables
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "name": "<string>",
    "producedBy": [
      {
        "ref": "<string>"
      }
    ],
    "consumedBy": [
      {
        "ref": "<string>"
      }
    ],
    "note": "<string>",
    "deletable": true,
    "type": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Path Parameters

​
agentId
string
required

Body

application/json

Declare or annotate a variable. Upserting an already-derived name is a 200, not a conflict.

​
name
string
required

The variable name. Stored case-sensitive; must match ^[a-zA-Z_][a-zA-Z0-9_]*$. The reserved names (caller_info, caller_number, caller_name, verified) cannot be declared.

​
note
string
​
type
string

An optional, never-enforced type hint.

Response

The upserted variable (merged derived ∪ annotation).

​
success
boolean
required
​
data
object
required

A merged interaction variable: the DERIVED registry (scanned from playbooks + skills) unioned with the per-agent annotation overlay. source, deletable, producedBy, and consumedBy are computed from the scan; note, type, and updatedAt come from the annotation. type is an OPTIONAL, nullable hint that is NEVER enforced.

​
message
string
​
errors
object[]