Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Cipta pelengkapan chat

Pelayan:https://openapi.felo.ai
Pustaka Klien

Cipta pelengkapan chat

​

API Chat Completions serasi OpenAI. Tetapkan stream=true untuk menerima Server-Sent Events. Respons dan sampul ralat mengikut bentuk Chat Completions/serasi OpenAI.

Pengepala
  • X-Felo-Channel
    Jenis: string

    Kod saluran awam yang dipisahkan koma dan tersusun. Tinggalkan pengepala ini untuk menggunakan default; default mesti digunakan secara bersendirian. Dalam mod dompet, default mengimbas susunan saluran awam berkesan model secara terbalik, melangkau saluran yang tidak diterbitkan atau tidak tersedia, dan memilih penyedia saluran pertama yang tersedia. Ia merangkumi endpoint tersedia daripada penyedia itu dengan ID model huluan dan tahap perkhidmatan yang sama. Saluran eksplisit disahkan mengikut susunan yang ditetapkan klien; hanya kumpulan penyedia saluran pertama yang dihantar. Tiada sandaran automatik kepada penyedia lain. Pengepala penyedia legasi tidak boleh mengatasi penghalaan saluran.

Badan·ChatCompletionRequest
wajib
application/json
  • messages
    Jenis: array object[] · ChatMessage[] 1…
    wajib
    • content
      boleh null
      wajib
      • Jenis: string
    • role
      Jenis: string enum
      wajib
      nilai
      • system
      • developer
      • user
      • assistant
      • tool
    • name
      Jenis: string
    • tool_call_id
      Jenis: string
    • tool_calls
      Jenis: array object[]
      • propertyName
        Jenis: anything
    • propertyName
      Jenis: anything
  • model
    Jenis: string
    wajib
  • max_completion_tokens
    Jenis: integer
    min:  
    1

    Integer numbers.

  • max_tokens
    Jenis: integer
    min:  
    1

    Integer numbers.

  • n
    Jenis: integer
    min:  
    1

    Integer numbers.

  • response_format
    Jenis: object
    • propertyName
      Jenis: anything
  • service_tier
    Jenis: string | null

    Pada masa ini hanya default (standard) disokong. Nilai yang ditinggalkan, null, alias dan rentetan tidak disokong akan kembali kepada default; jenis lain memulangkan HTTP 400. Saluran dan harga yang dikonfigurasikan kekal tidak berubah. API teks menghantar nilai standard penyedia; API Decisions dan penjanaan meninggalkan medan huluan.

  • stop
    boleh null
    • Jenis: string
  • stream
    Jenis: boolean
  • temperature
    Jenis: number
    min:  
    0
  • tool_choice
    • Jenis: string
  • tools
    Jenis: array object[]
    • propertyName
      Jenis: anything
  • propertyName
    Jenis: anything
  • top_p
    Jenis: number
    min:  
    0
    maks:  
    1
  • user
    Jenis: string
  • propertyName
    Jenis: anything
Respons
  • 200
    Jenis: object · ChatCompletionResponse

    Pelengkapan chat atau respons penstriman

    • choices
      Jenis: array object[] · ChatChoice[]
      wajib
      • finish_reason
        Jenis: string | null
      • index
        Jenis: integer

        Integer numbers.

      • logprobs
        Jenis: object | null
        • propertyName
          Jenis: anything
      • message
        Jenis: object · ChatMessage
        • content
          boleh null
          wajib
          • Jenis: string
        • role
          Jenis: string enum
          wajib
          nilai
          • system
          • developer
          • user
          • assistant
          • tool
        • name
          Jenis: string
        • tool_call_id
          Jenis: string
        • tool_calls
          Jenis: array object[]
          • propertyName
            Jenis: anything
        • propertyName
          Jenis: anything
      • propertyName
        Jenis: anything
    • id
      Jenis: string
      wajib
    • object
      Jenis: string
      wajib

      Biasanya chat.completion untuk respons tanpa penstriman.

    • created
      Jenis: integer Format: int64

      Signed 64-bit integers (long type).

    • model
      Jenis: string
    • system_fingerprint
      Jenis: string
    • usage
      Jenis: object · Usage

      Objek penggunaan penyedia. Medan berbeza mengikut endpoint dan penyedia.

      • propertyName
        Jenis: anything
    • propertyName
      Jenis: anything
  • 400
    Jenis: object · OpenAIErrorResponse

    Permintaan, model atau pemetaan penyedia tidak sah

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

      • propertyName
        Jenis: anything
    • propertyName
      Jenis: anything
    application/json
  • 401
    Jenis: object · OpenAIErrorResponse

    Kunci API Felo tidak sah atau tiada

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

      • propertyName
        Jenis: anything
    • propertyName
      Jenis: anything
    application/json
  • 402
    Jenis: object · OpenAIErrorResponse

    Baki tidak mencukupi

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

      • propertyName
        Jenis: anything
    • propertyName
      Jenis: anything
    application/json
  • 403
    Jenis: object · OpenAIErrorResponse

    Akaun tidak dibenarkan menggunakan model ini. Model yang dilumpuhkan juga ditolak sebelum panggilan huluan. Permintaan dan tugas yang telah diterima terus berjalan.

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

      • propertyName
        Jenis: anything
    • propertyName
      Jenis: anything
    application/json
  • 429
    Jenis: object · OpenAIErrorResponse

    Had perbelanjaan atau permintaan telah dicapai

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

      • propertyName
        Jenis: anything
    • propertyName
      Jenis: anything
    application/json
  • 502
    Jenis: object · OpenAIErrorResponse

    Permintaan kepada penyedia huluan gagal

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

      • propertyName
        Jenis: anything
    • propertyName
      Jenis: anything
    application/json
  • 503
    Jenis: object · OpenAIErrorResponse

    Penyedia atau perkhidmatan pengebilan tidak tersedia

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

      • propertyName
        Jenis: anything
    • propertyName
      Jenis: anything
    application/json
Request Example for 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
}'
{
  "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"
}
Create a chat completion