Chat Completions — POST /v1/chat/completions

Der Endpunkt /v1/chat/completions generiert eine Textvervollständigung auf Basis einer Liste von Nachrichten. Er ist der primäre Endpunkt für Chat-, Instruction-Following- und Textgenerierungsaufgaben. Das Anfrageformat ist identisch mit der OpenAI Chat Completions API, sodass jedes OpenAI-kompatible SDK ohne Änderungen funktioniert.

Endpunkt

POST https://router.flatkey.ai/v1/chat/completions

Anfrage

Header	Wert
`Authorization`	`Bearer $FLATKEY_API_KEY`
`Content-Type`	`application/json`

Body-Parameter

string

erforderlich

Die zu verwendende Modell-ID. Alle gültigen Werte finden Sie im Modellverzeichnis. Beispiel: "gpt-4o", "claude-sonnet-4-5", "gemini-2.5-flash".

array

erforderlich

Ein Array von Nachrichtenobjekten, das die Konversation repräsentiert. Jedes Objekt muss role ("system", "user" oder "assistant") und content (String) enthalten.

integer

Maximale Anzahl der zu generierenden Token. Standardwerte variieren je nach Modell.

number

Sampling-Temperatur zwischen 0 und 2. Höhere Werte erzeugen zufälligere Ausgaben. Standard: 1.

boolean

Wenn true, wird die Antwort als Stream von Server-Sent Events (SSE) zurückgegeben. Standard: false.

number

Nucleus-Sampling — es werden nur Token aus der obersten top_p-Wahrscheinlichkeitsmasse berücksichtigt. Standard: 1.

string | array

Eine oder mehrere Sequenzen, bei denen das Modell die Generierung stoppt. Kann ein String oder ein Array von Strings sein.

array

Eine Liste von Tool-Definitionen für Function Calling. Jedes Tool muss type: "function" und ein function-Objekt mit name, description und parameters enthalten.

string | object

Steuert die Tool-Auswahl: "none", "auto", "required" oder ein spezifisches Tool {"type": "function", "function": {"name": "..."}}.

Beispielanfrage

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["FLATKEY_API_KEY"],
    base_url="https://router.flatkey.ai/v1",
)

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "What is the speed of light?"},
    ],
    max_tokens=256,
    temperature=0.7,
)

print(response.choices[0].message.content)

curl https://router.flatkey.ai/v1/chat/completions \
  -H "Authorization: Bearer $FLATKEY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "What is the speed of light?"}
    ],
    "max_tokens": 256
  }'

Antwort

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1710000000,
  "model": "gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "The speed of light in a vacuum is approximately 299,792,458 meters per second."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 28,
    "completion_tokens": 22,
    "total_tokens": 50
  }
}

Antwortfelder

string

Eindeutiger Bezeichner für die Vervollständigung.

array

Array der generierten Vervollständigungs-Choices.

Anzeigen Choice-Eigenschaften

string

Der generierte Text.

string

Für generierte Nachrichten immer "assistant".

string

Grund für den Generierungsstopp: "stop" (natürliches Ende), "length" (max_tokens erreicht), "tool_calls" (Tool aufgerufen).

object

Token-Anzahl für die Abrechnung.

Anzeigen Usage-Eigenschaften

integer

Anzahl der Eingabe-Token.

integer

Anzahl der Ausgabe-Token.

integer

Summe aus Prompt- und Completion-Token.

Streaming

Setzen Sie stream: true, um einen Stream von SSE-Chunks zu empfangen. Jeder Chunk hat dieselbe Struktur, enthält jedoch partiellen delta-Inhalt anstelle einer vollständigen Nachricht:

python

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["FLATKEY_API_KEY"],
    base_url="https://router.flatkey.ai/v1",
)

stream = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Tell me a story."}],
    stream=True,
)

for chunk in stream:
    print(chunk.choices[0].delta.content or "", end="", flush=True)

Überblick

Endpunkte

Chat Completions — POST /v1/chat/completions

Endpunkt

Anfrage

Header

Body-Parameter

Beispielanfrage

Antwort

Antwortfelder

Streaming

​Endpunkt

​Anfrage

​Header

​Body-Parameter

​Beispielanfrage

​Antwort

​Antwortfelder

​Streaming

Endpunkt

Anfrage

Header

Body-Parameter

Beispielanfrage

Antwort

Antwortfelder

Streaming