Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"id": "agt_4f9c2b7e10a24d51",
"organizationId": "org_2a1b9c",
"name": "Peak Comfort HVAC — Front Desk",
"version": 7,
"status": "published",
"persona": "A warm, efficient front-desk agent for an HVAC company.",
"primaryLanguage": "en",
"languages": [
"en",
"es"
],
"sku": "code_switch",
"enabledChannels": [
"voice",
"chat"
],
"greeting": "Thanks for calling Peak Comfort HVAC — how can I help?",
"createdAt": "2026-07-01T14:32:00.000Z",
"updatedAt": "2026-07-12T09:15:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"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>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Agents
List agents
Returns a paginated list of your agents. You can filter by status (draft or published) or search by name.
GET
/
agents
Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"id": "agt_4f9c2b7e10a24d51",
"organizationId": "org_2a1b9c",
"name": "Peak Comfort HVAC — Front Desk",
"version": 7,
"status": "published",
"persona": "A warm, efficient front-desk agent for an HVAC company.",
"primaryLanguage": "en",
"languages": [
"en",
"es"
],
"sku": "code_switch",
"enabledChannels": [
"voice",
"chat"
],
"greeting": "Thanks for calling Peak Comfort HVAC — how can I help?",
"createdAt": "2026-07-01T14:32:00.000Z",
"updatedAt": "2026-07-12T09:15:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"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>"
}
]
}{
"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.
FlowClient Credentials
- Token URL
- /api/v1/api-keys
Scopes1
agents:read
Read agents.
Query Parameters
1-based page number for offset pagination. Defaults to 1 (the first page).
Required range:
x >= 1Page size — how many items to return per page (1–100). Defaults to 20.
Required range:
1 <= x <= 100Filter by lifecycle state — draft (never published or has unpublished edits) or published.
Available options:
draft, published Free-text name search.