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.

Headers

Idempotency-Key
string

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.

Body

application/json
name
string
required

Display name for the agent (the only required field).

primaryLanguage
string

BCP-47 primary language (e.g. "en"). Defaults to English when omitted.

languages
string[]

Additional BCP-47 languages the agent understands/speaks, beyond the primary.

templateId
string

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.

Response

Created agent.

success
boolean
required
data
object
required
message
string
errors
object[]