Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"version": 123,
"persona": "<string>",
"primaryLanguage": "<string>",
"languages": [
"<string>"
],
"enabledChannels": [],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"goals": [
"<string>"
],
"neverDo": [
"<string>"
],
"tone": "<string>",
"lexicon": {
"preferred": [
"<string>"
],
"banned": [
"<string>"
],
"pronunciations": {}
},
"voiceMap": {},
"defaultVoiceId": "<string>",
"voiceSettings": {
"stability": 123,
"similarityBoost": 123,
"style": 123,
"useSpeakerBoost": true,
"speed": 123
},
"llmModel": "<string>",
"llmTemperature": 123,
"ttsModel": "<string>",
"sttModel": "<string>",
"endpointing": {
"minSilenceMs": 123,
"maxSilenceMs": 123,
"semantic": true
},
"greeting": "<string>",
"handoffConfig": {
"warm": true,
"transferDestination": "<string>",
"escalationThreshold": 123,
"contextSummaryUrl": "<string>",
"transferRules": [
{
"label": "<string>",
"when": "<string>",
"destination": "<string>"
}
]
},
"callControl": {
"maxCallSeconds": 123,
"maxDurationMessage": "<string>",
"idleReminderDelaySeconds": 123,
"idleReminderIntervalSeconds": 123,
"maxIdleReminders": 123,
"endCallPhrasesEnabled": true
},
"businessHours": {
"timezone": "<string>",
"weekly": {},
"holidays": [
{
"date": "<string>",
"name": "<string>",
"endDate": "<string>",
"closed": true,
"ranges": [
{
"start": "<string>",
"end": "<string>"
}
]
}
],
"afterHours": {
"mode": "<string>",
"message": "<string>",
"allowHumanTransfer": true,
"number": "<string>",
"emergencyNumber": "<string>"
}
},
"channelOverrides": {},
"avgTicketCents": 123,
"publishedVersionId": "<string>",
"isActive": true,
"createdBy": "<string>"
},
"message": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Agents
Create an agent
Creates a new agent. The agent starts as a draft; publish it before it can take live calls or chats.
POST
/
agents
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"version": 123,
"persona": "<string>",
"primaryLanguage": "<string>",
"languages": [
"<string>"
],
"enabledChannels": [],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"goals": [
"<string>"
],
"neverDo": [
"<string>"
],
"tone": "<string>",
"lexicon": {
"preferred": [
"<string>"
],
"banned": [
"<string>"
],
"pronunciations": {}
},
"voiceMap": {},
"defaultVoiceId": "<string>",
"voiceSettings": {
"stability": 123,
"similarityBoost": 123,
"style": 123,
"useSpeakerBoost": true,
"speed": 123
},
"llmModel": "<string>",
"llmTemperature": 123,
"ttsModel": "<string>",
"sttModel": "<string>",
"endpointing": {
"minSilenceMs": 123,
"maxSilenceMs": 123,
"semantic": true
},
"greeting": "<string>",
"handoffConfig": {
"warm": true,
"transferDestination": "<string>",
"escalationThreshold": 123,
"contextSummaryUrl": "<string>",
"transferRules": [
{
"label": "<string>",
"when": "<string>",
"destination": "<string>"
}
]
},
"callControl": {
"maxCallSeconds": 123,
"maxDurationMessage": "<string>",
"idleReminderDelaySeconds": 123,
"idleReminderIntervalSeconds": 123,
"maxIdleReminders": 123,
"endCallPhrasesEnabled": true
},
"businessHours": {
"timezone": "<string>",
"weekly": {},
"holidays": [
{
"date": "<string>",
"name": "<string>",
"endDate": "<string>",
"closed": true,
"ranges": [
{
"start": "<string>",
"end": "<string>"
}
]
}
],
"afterHours": {
"mode": "<string>",
"message": "<string>",
"allowHumanTransfer": true,
"number": "<string>",
"emergencyNumber": "<string>"
}
},
"channelOverrides": {},
"avgTicketCents": 123,
"publishedVersionId": "<string>",
"isActive": true,
"createdBy": "<string>"
},
"message": "<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.
Headers
Client-supplied idempotency key on mutating POSTs (API-First).
⌘I