Error
A valid request URL is required to generate request examples{
"id": "chatcmpl_7f21",
"object": "chat.completion",
"created": 1784000000,
"model": "agt_4f9c2b7e10a24d51",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Yes — we service heat pumps 7 days a week."
},
"finish_reason": "stop"
}
]
}{
"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>"
}
]
}Chat
OpenAI-compatible chat completions
An OpenAI-compatible chat completions endpoint where the model field is your agent ID. Set stream to true for streamed chunks. Existing OpenAI SDK clients work by pointing the base URL at this API.
POST
/
chat
/
completions
Error
A valid request URL is required to generate request examples{
"id": "chatcmpl_7f21",
"object": "chat.completion",
"created": 1784000000,
"model": "agt_4f9c2b7e10a24d51",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Yes — we service heat pumps 7 days a week."
},
"finish_reason": "stop"
}
]
}{
"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
chat:write
Create chat sessions & send messages (server-side).
Body
application/json