dokumentasi
API

Chat Completions

Markdown

Respons model terhadap perbualan dalam format OpenAI. Format yang paling lazim: hampir semua klien memahaminya.

Panduan lengkap
POSThttps://api.ailoot.ai/v1/chat/completions
Chat Completions
curl https://api.ailoot.ai/v1/chat/completions \
  -H "Authorization: Bearer $AILOOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-5-5",
    "messages": [
      {"role": "user", "content": "Terangkan dalam dua ayat apa itu API."}
    ]
  }' 
200 OK
{
  "id": "chatcmpl-8f2c…",
  "object": "chat.completion",
  "created": 1790812800,
  "model": "claude-sonnet-5-5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "API ialah persetujuan tentang cara satu program meminta program lain melakukan sesuatu…"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 21,
    "completion_tokens": 48,
    "total_tokens": 69
  }
}

Pengesahan

  • Authorizationheaderwajib

    Kunci dalam bentuk Bearer sk-…. Pengepala berikut juga boleh digunakan x-api-key atau x-goog-api-key.

Badan permintaan

  • modelstringwajib

    ID model daripada katalog, contohnya claude-sonnet-5-5. Model mesti menyokong format OpenAI Chat.

  • messagesarraywajib

    Sejarah perbualan: objek dengan role (system, developer, user, assistant, tool) dan content — rentetan atau tatasusunan bahagian (teks, image_url).

  • streambooleanpilihan

    Respons dalam format Server-Sent Events. Nilai lalai ialah false. Teks berbayar diterima sebagai satu blok selepas kos dikira, bukan perkataan demi perkataan.

  • stream_optionsobjectpilihan

    {"include_usage": true} — hantar nilai akhir usage sebagai peristiwa terakhir aliran.

  • max_tokensintegerpilihan

    Bilangan maksimum token respons. Nama baharunya — max_completion_tokens. Jika had tidak dinyatakan, Ailoot menetapkan 4096 (atau kurang jika had respons model lebih rendah; Grok mempunyai had tersendiri). Untuk respons panjang, nyatakan had secara jelas, jika tidak respons akan berhenti pada 4096 token dengan finish_reason: "length". Had ini dimasukkan dalam rizab: semakin besar hadnya, semakin banyak baki tersedia yang diperlukan.

  • temperaturenumberpilihan

    Tahap rawak respons, biasanya dari 0 hingga 2. Model penaakulan mungkin mengabaikannya.

  • top_pnumberpilihan

    Alternatif kepada temperature: bahagian jisim kebarangkalian untuk pemilihan token.

  • stopstring | arraypilihan

    Rentetan yang menghentikan penjanaan.

  • toolsarraypilihan

    Penerangan fungsi yang boleh dipanggil oleh model. Formatnya seperti OpenAI: {"type": "function", "function": {...}}.

  • tool_choicestring | objectpilihan

    auto, none, required atau fungsi tertentu.

  • response_formatobjectpilihan

    {"type": "json_object"} atau {"type": "json_schema", ...} untuk respons berstruktur — jika model menyokongnya.

  • reasoning_effortstringpilihan

    Kedalaman penaakulan bagi model penaakulan: low, medium, high.

Parameter OpenAI yang lain dihantar tanpa perubahan; pembangun model menentukan sama ada model tertentu menyokongnya.

Respons

  • choices[].messageobject

    Respons model: content, apabila alat dipanggil — tool_calls.

  • choices[].finish_reasonstring

    stop — respons telah selesai; length — mencapai had max_tokens (respons seperti ini tetap dianggap lengkap dan dicaj berdasarkan penggunaan sebenar); tool_calls — model memanggil alat.

  • usageobject

    prompt_tokens, completion_tokens, total_tokens — caj dikira berdasarkan nilai ini.

Masih ada soalan? Hantar Request ID dan penerangannya — kami akan membantu menyiasatnya.Hubungi sokongan