Skip to main content
POST
Error

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

The agent this resource is scoped to (the UUID returned by createAgent / listAgents).

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

A free-text note describing what the variable holds (shown in the registry; no runtime effect).

type
string

An optional, never-enforced type hint (e.g. string, date, number, email).

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[]