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.

FlowClient Credentials
Token URL
/api/v1/api-keys
Scopes1
chat:write
Create chat sessions & send messages (server-side).

Body

application/json

OpenAI-compatible request. model is the agentId.

model
string
required
messages
object[]
required
stream
boolean
user
string

Response

ChatCompletion (json) or OpenAI SSE chunks (stream).

OpenAI-compatible non-streamed response.

id
string
object
enum<string>
Available options:
chat.completion
created
integer
model
string
choices
object[]