v0.4.0

OpenAPI 3.1.0

Eine Chat-Completion erstellen

Felo API Support

MIT

Server

https://openapi.felo.ai

Client-Bibliotheken

Shell Curl

Eine Chat-Completion erstellen

OpenAI-kompatible Chat-Completions-API. Setzen Sie stream=true, um Server-Sent Events zu empfangen. Die Antwort und das Fehler-Envelope folgen der Chat-Completions-/OpenAI-kompatiblen Form.

Header

X-Felo-Channel
Typ: string

Geordnete, durch Kommas getrennte öffentliche Kanalcodes. Lassen Sie diesen Header weg, um default zu verwenden; default muss allein verwendet werden. Im Wallet-Modus durchsucht default die effektive öffentliche Kanalreihenfolge des Modells in umgekehrter Reihenfolge, überspringt nicht veröffentlichte oder nicht verfügbare Kanäle und wählt den Anbieter des ersten verfügbaren Kanals. Der Wert default schließt verfügbare Endpunkte dieses Anbieters mit derselben Upstream-Modell-ID und demselben Service-Tier ein. Explizite Kanäle werden in der vom Client angegebenen Reihenfolge validiert; nur die Anbietergruppe des ersten Kanals wird übermittelt. Kein automatischer Fallback auf andere Anbieter. Legacy-Anbieter-Header können das Kanal-Routing nicht überschreiben.

Body·ChatCompletionRequest

erforderlich

application/json

messages
Typ: array object[] · ChatMessage[] 1…
erforderlich
- content
  nullable
  erforderlich
  Typ: string
- role
  Typ: string enum
  erforderlich
  Werte
  system
  developer
  user
  assistant
  tool
- name
  Typ: string
- tool_call_id
  Typ: string
- tool_calls
  Typ: array object[]
  propertyName
  Typ: anything
- propertyName
  Typ: anything
model
Typ: string
erforderlich
max_completion_tokens
Typ: integer
min.:
1

Integer numbers.
max_tokens
Typ: integer
min.:
1

Integer numbers.
n
Typ: integer
min.:
1

Integer numbers.
response_format
Typ: object
- propertyName
  Typ: anything
service_tier
Typ: string | null

Derzeit wird nur default (standard) unterstützt. Weggelassene Werte, null, Aliase und nicht unterstützte Zeichenfolgen fallen auf default zurück; andere Typen liefern HTTP 400. Konfigurierte Kanäle und Preise bleiben unverändert. Text-APIs senden den Standardwert des Anbieters; Decisions- und Generierungs-APIs lassen das Upstream-Feld weg.
stop
nullable
Typ: string
stream
Typ: boolean
temperature
Typ: number
min.:
0
tool_choice
Typ: string
tools
Typ: array object[]
- propertyName
  Typ: anything
propertyName
Typ: anything

top_p
Typ: number
min.:
0
max.:
1
user
Typ: string
propertyName
Typ: anything

Antworten

200
Typ: object · ChatCompletionResponse

Chat-Completion oder Streaming-Antwort
choices
Typ: array object[] · ChatChoice[]
erforderlich
finish_reason
Typ: string | null
index
Typ: integer

Integer numbers.

logprobs
Typ: object | null
propertyName
Typ: anything
message
Typ: object · ChatMessage
content
nullable
erforderlich
Typ: string
role
Typ: string enum
erforderlich
Werte
system
developer
user
assistant
tool
name
Typ: string
tool_call_id
Typ: string
tool_calls
Typ: array object[]
propertyName
Typ: anything
propertyName
Typ: anything
propertyName
Typ: anything
id
Typ: string
erforderlich
object
Typ: string
erforderlich

Üblicherweise chat.completion bei Nicht-Streaming-Antworten.

created
Typ: integer Format: int64

Signed 64-bit integers (long type).

model
Typ: string
system_fingerprint
Typ: string
usage
Typ: object · Usage

Nutzungsobjekt des Anbieters. Die Felder variieren je nach Endpunkt und Anbieter.

propertyName
Typ: anything
propertyName
Typ: anything
400
Typ: object · OpenAIErrorResponse

Ungültige Anfrage, ungültiges Modell oder ungültige Anbieterzuordnung

OpenAI-kompatibles Fehler-Envelope. Der Router kann code und message ohne alle optionalen Upstream-Felder einschließen.
error
Typ: object
erforderlich
message
Typ: string
erforderlich
code
Typ: string | null
param
Typ: string | null
type
Typ: string

OpenAI-kompatibler Fehlertyp, sofern angegeben.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
401
Typ: object · OpenAIErrorResponse

Ungültiger oder fehlender Felo-API-Schlüssel

OpenAI-kompatibles Fehler-Envelope. Der Router kann code und message ohne alle optionalen Upstream-Felder einschließen.
error
Typ: object
erforderlich
message
Typ: string
erforderlich
code
Typ: string | null
param
Typ: string | null
type
Typ: string

OpenAI-kompatibler Fehlertyp, sofern angegeben.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
402
Typ: object · OpenAIErrorResponse

Unzureichendes Guthaben

OpenAI-kompatibles Fehler-Envelope. Der Router kann code und message ohne alle optionalen Upstream-Felder einschließen.
error
Typ: object
erforderlich
message
Typ: string
erforderlich
code
Typ: string | null
param
Typ: string | null
type
Typ: string

OpenAI-kompatibler Fehlertyp, sofern angegeben.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
403
Typ: object · OpenAIErrorResponse

Das Konto ist nicht berechtigt, das Modell zu verwenden. Deaktivierte Modelle werden ebenfalls vor Upstream-Aufrufen abgelehnt. Bereits angenommene Anfragen und Aufgaben werden fortgesetzt.

OpenAI-kompatibles Fehler-Envelope. Der Router kann code und message ohne alle optionalen Upstream-Felder einschließen.
error
Typ: object
erforderlich
message
Typ: string
erforderlich
code
Typ: string | null
param
Typ: string | null
type
Typ: string

OpenAI-kompatibler Fehlertyp, sofern angegeben.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
429
Typ: object · OpenAIErrorResponse

Ausgaben- oder Anfragelimit erreicht

OpenAI-kompatibles Fehler-Envelope. Der Router kann code und message ohne alle optionalen Upstream-Felder einschließen.
error
Typ: object
erforderlich
message
Typ: string
erforderlich
code
Typ: string | null
param
Typ: string | null
type
Typ: string

OpenAI-kompatibler Fehlertyp, sofern angegeben.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
502
Typ: object · OpenAIErrorResponse

Anfrage an den Upstream-Anbieter fehlgeschlagen

OpenAI-kompatibles Fehler-Envelope. Der Router kann code und message ohne alle optionalen Upstream-Felder einschließen.
error
Typ: object
erforderlich
message
Typ: string
erforderlich
code
Typ: string | null
param
Typ: string | null
type
Typ: string

OpenAI-kompatibler Fehlertyp, sofern angegeben.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
503
Typ: object · OpenAIErrorResponse

Anbieter- oder Abrechnungsdienst nicht verfügbar

OpenAI-kompatibles Fehler-Envelope. Der Router kann code und message ohne alle optionalen Upstream-Felder einschließen.
error
Typ: object
erforderlich
message
Typ: string
erforderlich
code
Typ: string | null
param
Typ: string | null
type
Typ: string

OpenAI-kompatibler Fehlertyp, sofern angegeben.

propertyName
Typ: anything
propertyName
Typ: anything
application/json

post/api/v1/chat/completions

curl https://openapi.felo.ai/api/v1/chat/completions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "gpt-5.5",
  "messages": [
    {
      "role": "user",
      "content": "Write a one-sentence greeting."
    }
  ],
  "stream": false
}'

Schema anzeigen

{
  "id": "string",
  "object": "string",
  "created": 1,
  "model": "string",
  "choices": [
    {
      "index": 1,
      "message": {
        "role": "system",
        "content": "string",
        "name": "string",
        "tool_call_id": "string",
        "tool_calls": [
          {
            "additionalProperty": "anything"
          }
        ],
        "additionalProperty": "anything"
      },
      "finish_reason": null,
      "logprobs": null,
      "additionalProperty": "anything"
    }
  ],
  "usage": {
    "additionalProperty": "anything"
  },
  "system_fingerprint": "string",
  "additionalProperty": "anything"
}

Chat-Completion oder Streaming-Antwort

Eine Chat-Completion erstellen

AuthentifizierungRequired

Eine Chat-Completion erstellen