Chat Completions — POST /v1/chat/completions

Endpoint /v1/chat/completions menghasilkan penyelesaian teks berdasarkan daftar pesan. Ini adalah endpoint utama untuk obrolan, mengikuti instruksi, dan tugas pembuatan teks. Format permintaan identik dengan OpenAI Chat Completions API, sehingga SDK apa pun yang kompatibel dengan OpenAI dapat digunakan tanpa modifikasi.

Endpoint

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

Permintaan

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

Parameter body

string

wajib

ID model yang akan digunakan. Lihat Direktori Model untuk semua nilai yang valid. Contoh: "gpt-4o", "claude-sonnet-4-5", "gemini-2.5-flash".

array

wajib

Array objek pesan yang merepresentasikan percakapan. Setiap objek harus memiliki role ("system", "user", atau "assistant") dan content (string).

integer

Jumlah maksimum token yang akan dihasilkan. Nilai default bervariasi tergantung model.

number

Temperatur sampling antara 0 dan 2. Nilai yang lebih tinggi menghasilkan output yang lebih acak. Default: 1.

boolean

Jika true, respons dikembalikan sebagai aliran peristiwa yang dikirim server (SSE). Default: false.

number

Nucleus sampling — hanya token dalam massa probabilitas top_p teratas yang dipertimbangkan. Default: 1.

string | array

Satu atau lebih urutan di mana model berhenti menghasilkan. Dapat berupa string atau array string.

array

Daftar definisi alat untuk pemanggilan fungsi. Setiap alat harus memiliki type: "function" dan objek function dengan name, description, dan parameters.

string | object

Mengontrol pemilihan alat: "none", "auto", "required", atau alat tertentu {"type": "function", "function": {"name": "..."}}.

Contoh permintaan

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
  }'

Respons

{
  "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
  }
}

Kolom respons

string

Pengenal unik untuk penyelesaian.

array

Array pilihan penyelesaian yang dihasilkan.

Tampilkan properti choice

string

Teks yang dihasilkan.

string

Selalu "assistant" untuk pesan yang dihasilkan.

string

Alasan generasi berhenti: "stop" (berakhir secara alami), "length" (max_tokens tercapai), "tool_calls" (alat dipanggil).

object

Jumlah token untuk penagihan.

Tampilkan properti usage

integer

Jumlah token input.

integer

Jumlah token output.

integer

Jumlah token prompt dan penyelesaian.

Streaming

Atur stream: true untuk menerima aliran potongan SSE. Setiap potongan memiliki struktur yang sama tetapi dengan konten delta parsial alih-alih pesan lengkap:

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)

​Endpoint

​Permintaan

​Header

​Parameter body

​Contoh permintaan

​Respons

​Kolom respons

​Streaming

Endpoint

Permintaan

Header

Parameter body

Contoh permintaan

Respons

Kolom respons

Streaming