v0.4.0

OpenAPI 3.1.0

Tạo một chat completion

Felo API Support

MIT

Máy chủ

https://openapi.felo.ai

Thư viện client

Shell Curl

Tạo một chat completion

API Chat Completions tương thích OpenAI. Đặt stream=true để nhận Server-Sent Events. Phản hồi và cấu trúc lỗi tuân theo cấu trúc Chat Completions/tương thích OpenAI.

Header

X-Felo-Channel
Kiểu: string

Mã kênh công khai được phân tách bằng dấu phẩy, có thứ tự. Bỏ trống header này để dùng default; default phải được dùng một mình. Ở chế độ ví, default quét thứ tự kênh công khai hiệu dụng của mô hình theo chiều ngược, bỏ qua các kênh chưa xuất bản hoặc không khả dụng, và chọn nhà cung cấp của kênh khả dụng đầu tiên. Nó bao gồm các endpoint khả dụng của nhà cung cấp đó có cùng ID mô hình upstream và cùng hạng dịch vụ. Các kênh chỉ định rõ được kiểm tra theo thứ tự do client chỉ định; chỉ nhóm nhà cung cấp của kênh đầu tiên được gửi đi. Không tự động dự phòng sang nhà cung cấp khác. Header nhà cung cấp kiểu cũ không thể ghi đè định tuyến kênh.

Phần thân·ChatCompletionRequest

bắt buộc

application/json

messages
Kiểu: array object[] · ChatMessage[] 1…
bắt buộc
- content
  có thể null
  bắt buộc
  Kiểu: string
- role
  Kiểu: string enum
  bắt buộc
  giá trị
  system
  developer
  user
  assistant
  tool
- name
  Kiểu: string
- tool_call_id
  Kiểu: string
- tool_calls
  Kiểu: array object[]
  propertyName
  Kiểu: anything
- propertyName
  Kiểu: anything
model
Kiểu: string
bắt buộc
max_completion_tokens
Kiểu: integer
tối thiểu:
1

Integer numbers.
max_tokens
Kiểu: integer
tối thiểu:
1

Integer numbers.
n
Kiểu: integer
tối thiểu:
1

Integer numbers.
response_format
Kiểu: object
- propertyName
  Kiểu: anything
service_tier
Kiểu: string | null

Hiện chỉ hỗ trợ default (tiêu chuẩn). Giá trị bị bỏ trống, null, các bí danh và chuỗi không được hỗ trợ đều quay về default; các loại khác trả về HTTP 400. Các kênh và giá đã cấu hình không thay đổi. API văn bản gửi giá trị tiêu chuẩn của nhà cung cấp; API Decisions và tạo nội dung bỏ qua trường upstream.
stop
có thể null
Kiểu: string
stream
Kiểu: boolean
temperature
Kiểu: number
tối thiểu:
0
tool_choice
Kiểu: string
tools
Kiểu: array object[]
- propertyName
  Kiểu: anything
propertyName
Kiểu: anything

top_p
Kiểu: number
tối thiểu:
0
tối đa:
1
user
Kiểu: string
propertyName
Kiểu: anything

Phản hồi

200
Kiểu: object · ChatCompletionResponse

Chat completion hoặc phản hồi streaming
choices
Kiểu: array object[] · ChatChoice[]
bắt buộc
finish_reason
Kiểu: string | null
index
Kiểu: integer

Integer numbers.

logprobs
Kiểu: object | null
propertyName
Kiểu: anything
message
Kiểu: object · ChatMessage
content
có thể null
bắt buộc
Kiểu: string
role
Kiểu: string enum
bắt buộc
giá trị
system
developer
user
assistant
tool
name
Kiểu: string
tool_call_id
Kiểu: string
tool_calls
Kiểu: array object[]
propertyName
Kiểu: anything
propertyName
Kiểu: anything
propertyName
Kiểu: anything
id
Kiểu: string
bắt buộc
object
Kiểu: string
bắt buộc

Thường là chat.completion với phản hồi không streaming.

created
Kiểu: integer Định dạng: int64

Signed 64-bit integers (long type).

model
Kiểu: string
system_fingerprint
Kiểu: string
usage
Kiểu: object · Usage

Đối tượng mức sử dụng của nhà cung cấp. Các trường thay đổi tùy theo endpoint và nhà cung cấp.

propertyName
Kiểu: anything
propertyName
Kiểu: anything
400
Kiểu: object · OpenAIErrorResponse

Yêu cầu, mô hình hoặc ánh xạ nhà cung cấp không hợp lệ

Phong bì lỗi tương thích OpenAI. Router có thể bao gồm code và message mà không có đầy đủ các trường upstream tùy chọn.
error
Kiểu: object
bắt buộc
message
Kiểu: string
bắt buộc
code
Kiểu: string | null
param
Kiểu: string | null
type
Kiểu: string

Loại lỗi tương thích OpenAI khi được cung cấp.

propertyName
Kiểu: anything
propertyName
Kiểu: anything
application/json
401
Kiểu: object · OpenAIErrorResponse

Khóa API Felo không hợp lệ hoặc bị thiếu

Phong bì lỗi tương thích OpenAI. Router có thể bao gồm code và message mà không có đầy đủ các trường upstream tùy chọn.
error
Kiểu: object
bắt buộc
message
Kiểu: string
bắt buộc
code
Kiểu: string | null
param
Kiểu: string | null
type
Kiểu: string

Loại lỗi tương thích OpenAI khi được cung cấp.

propertyName
Kiểu: anything
propertyName
Kiểu: anything
application/json
402
Kiểu: object · OpenAIErrorResponse

Số dư không đủ

Phong bì lỗi tương thích OpenAI. Router có thể bao gồm code và message mà không có đầy đủ các trường upstream tùy chọn.
error
Kiểu: object
bắt buộc
message
Kiểu: string
bắt buộc
code
Kiểu: string | null
param
Kiểu: string | null
type
Kiểu: string

Loại lỗi tương thích OpenAI khi được cung cấp.

propertyName
Kiểu: anything
propertyName
Kiểu: anything
application/json
403
Kiểu: object · OpenAIErrorResponse

Tài khoản không được phép sử dụng mô hình. Các mô hình đã bị vô hiệu hóa cũng bị từ chối trước khi gọi upstream. Các yêu cầu và tác vụ đã được tiếp nhận vẫn tiếp tục.

Phong bì lỗi tương thích OpenAI. Router có thể bao gồm code và message mà không có đầy đủ các trường upstream tùy chọn.
error
Kiểu: object
bắt buộc
message
Kiểu: string
bắt buộc
code
Kiểu: string | null
param
Kiểu: string | null
type
Kiểu: string

Loại lỗi tương thích OpenAI khi được cung cấp.

propertyName
Kiểu: anything
propertyName
Kiểu: anything
application/json
429
Kiểu: object · OpenAIErrorResponse

Đã đạt giới hạn chi tiêu hoặc số yêu cầu

Phong bì lỗi tương thích OpenAI. Router có thể bao gồm code và message mà không có đầy đủ các trường upstream tùy chọn.
error
Kiểu: object
bắt buộc
message
Kiểu: string
bắt buộc
code
Kiểu: string | null
param
Kiểu: string | null
type
Kiểu: string

Loại lỗi tương thích OpenAI khi được cung cấp.

propertyName
Kiểu: anything
propertyName
Kiểu: anything
application/json
502
Kiểu: object · OpenAIErrorResponse

Yêu cầu tới nhà cung cấp upstream thất bại

Phong bì lỗi tương thích OpenAI. Router có thể bao gồm code và message mà không có đầy đủ các trường upstream tùy chọn.
error
Kiểu: object
bắt buộc
message
Kiểu: string
bắt buộc
code
Kiểu: string | null
param
Kiểu: string | null
type
Kiểu: string

Loại lỗi tương thích OpenAI khi được cung cấp.

propertyName
Kiểu: anything
propertyName
Kiểu: anything
application/json
503
Kiểu: object · OpenAIErrorResponse

Nhà cung cấp hoặc dịch vụ thanh toán không khả dụng

Phong bì lỗi tương thích OpenAI. Router có thể bao gồm code và message mà không có đầy đủ các trường upstream tùy chọn.
error
Kiểu: object
bắt buộc
message
Kiểu: string
bắt buộc
code
Kiểu: string | null
param
Kiểu: string | null
type
Kiểu: string

Loại lỗi tương thích OpenAI khi được cung cấp.

propertyName
Kiểu: anything
propertyName
Kiểu: 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
}'

Hiện schema

{
  "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 hoặc phản hồi streaming

Tạo một chat completion

Xác thựcRequired

Tạo một chat completion