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": 1,
"status": "draft",
"persona": "",
"primaryLanguage": "en",
"languages": [
"en",
"es"
],
"sku": "code_switch",
"enabledChannels": [
"voice"
],
"createdAt": "2026-07-13T10:00:00.000Z",
"updatedAt": "2026-07-13T10:00:00.000Z"
}
}{
"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>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Create an agent
Creates a new agent. The agent starts as a draft; publish it before it can take live calls or chats.
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": 1,
"status": "draft",
"persona": "",
"primaryLanguage": "en",
"languages": [
"en",
"es"
],
"sku": "code_switch",
"enabledChannels": [
"voice"
],
"createdAt": "2026-07-13T10:00:00.000Z",
"updatedAt": "2026-07-13T10:00:00.000Z"
}
}{
"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>"
}
]
}{
"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
Headers
Client-supplied idempotency key on mutating POSTs. Retrying the same request with the same key returns the original result instead of creating a duplicate — send a fresh UUID per logical operation. The prefixes api_sms_send: and harness_initiate: are reserved for the platform's own records, so do not use them; an endpoint that records the key refuses one that starts with either with 400 validation_error.
Body
Display name for the agent (the only required field).
BCP-47 primary language (e.g. "en"). Defaults to English when omitted.
Additional BCP-47 languages the agent understands/speaks, beyond the primary.
Optional starter template to pre-fill persona / skills / greeting. Omit to create a blank draft. To instead populate a draft from a website or SOP, use scaffoldAgent.