A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"name": "appointment_date",
"source": "both",
"type": "date",
"producedBy": [
{
"kind": "collect",
"ref": "Book a visit · Collect"
}
],
"consumedBy": [
{
"kind": "message",
"ref": "Confirmation message"
},
{
"kind": "binding",
"ref": "Skill create_booking"
}
],
"note": "Preferred visit date the caller gives us.",
"deletable": false,
"updatedAt": "2026-07-10T14:22:05.000Z"
},
{
"name": "caller_name",
"source": "derived",
"type": null,
"producedBy": [
{
"kind": "collect",
"ref": "Greeting · Collect"
}
],
"consumedBy": [
{
"kind": "message",
"ref": "Greeting message"
}
],
"note": "",
"deletable": false
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 2,
"totalPages": 1
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}List interaction variables
Returns the agent’s interaction variables — the values that flow through a call (collected slots, skill outputs, and {placeholder} references). The list is derived by scanning the agent’s enabled playbooks and skills, then merged with any notes or type hints you’ve added. It’s a read-only view of how variables flow; it never validates references or affects publishing or runtime. Sorted by name.
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"name": "appointment_date",
"source": "both",
"type": "date",
"producedBy": [
{
"kind": "collect",
"ref": "Book a visit · Collect"
}
],
"consumedBy": [
{
"kind": "message",
"ref": "Confirmation message"
},
{
"kind": "binding",
"ref": "Skill create_booking"
}
],
"note": "Preferred visit date the caller gives us.",
"deletable": false,
"updatedAt": "2026-07-10T14:22:05.000Z"
},
{
"name": "caller_name",
"source": "derived",
"type": null,
"producedBy": [
{
"kind": "collect",
"ref": "Greeting · Collect"
}
],
"consumedBy": [
{
"kind": "message",
"ref": "Greeting message"
}
],
"note": "",
"deletable": false
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 2,
"totalPages": 1
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
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.
- Token URL
- /api/v1/api-keys
Path Parameters
The agent this resource is scoped to (the UUID returned by createAgent / listAgents).
Query Parameters
1-based page number for offset pagination. Defaults to 1 (the first page).
x >= 1Page size — how many items to return per page (1–100). Defaults to 20.
1 <= x <= 100