Skip to main content
POST
/
chat
/
completions
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "object": "chat.completion",
  "created": 123,
  "model": "<string>",
  "choices": [
    {
      "index": 123,
      "message": {
        "role": "<string>",
        "content": "<string>"
      },
      "finish_reason": "<string>"
    }
  ]
}

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.

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[]