v0.4.0

OpenAPI 3.1.0

ایجاد یک تکمیل چت

Felo API Support

MIT

سرور

https://openapi.felo.ai

کتابخانه‌های کلاینت

Shell Curl

ایجاد یک تکمیل چت

API Chat Completions سازگار با OpenAI. برای دریافت رویدادهای ارسالی سرور، stream=true را تنظیم کنید. پاسخ و پاکت خطا از شکل Chat Completions/سازگار با OpenAI پیروی می‌کنند.

هدرها

X-Felo-Channel
نوع: string

کدهای کانال عمومی جداشده با کاما و مرتب‌شده. برای استفاده از default این هدر را حذف کنید؛ default باید به‌تنهایی استفاده شود. در حالت کیف پول، default ترتیب مؤثر کانال‌های عمومی مدل را به‌صورت معکوس بررسی می‌کند، کانال‌های منتشرنشده یا در دسترس نبودن را رد می‌کند و ارائه‌دهنده اولین کانال در دسترس را انتخاب می‌کند. نقاط پایانی در دسترس آن ارائه‌دهنده با همان شناسه مدل بالادست و سطح سرویس را شامل می‌شود. کانال‌های صریح به ترتیب مشخص‌شده توسط کلاینت اعتبارسنجی می‌شوند؛ فقط گروه ارائه‌دهنده اولین کانال ارسال می‌شود. هیچ بازگشت خودکار به ارائه‌دهندگان دیگر وجود ندارد. هدرهای ارائه‌دهنده قدیمی نمی‌توانند مسیریابی کانال را بازنویسی کنند.

بدنه·ChatCompletionRequest

الزامی

application/json

messages
نوع: array object[] · ChatMessage[] 1…
الزامی
- content
  تهی‌پذیر
  الزامی
  نوع: string
- role
  نوع: string فهرست مقادیر
  الزامی
  مقادیر
  system
  developer
  user
  assistant
  tool
- name
  نوع: string
- tool_call_id
  نوع: string
- tool_calls
  نوع: array object[]
  propertyName
  نوع: anything
- propertyName
  نوع: anything
model
نوع: string
الزامی
max_completion_tokens
نوع: integer
حداقل:
1

Integer numbers.
max_tokens
نوع: integer
حداقل:
1

Integer numbers.
n
نوع: integer
حداقل:
1

Integer numbers.
response_format
نوع: object
- propertyName
  نوع: anything
service_tier
نوع: string | null

در حال حاضر فقط default (استاندارد) پشتیبانی می‌شود. مقادیر حذف‌شده، null، نام‌های مستعار و رشته‌های پشتیبانی‌نشده به default بازمی‌گردند؛ انواع دیگر HTTP 400 برمی‌گردانند. کانال‌ها و قیمت‌های پیکربندی‌شده بدون تغییر می‌مانند. APIهای متنی مقدار استاندارد ارائه‌دهنده را ارسال می‌کنند؛ APIهای Decisions و تولید فیلد بالادست را حذف می‌کنند.
stop
تهی‌پذیر
نوع: string
stream
نوع: boolean
temperature
نوع: number
حداقل:
0
tool_choice
نوع: string
tools
نوع: array object[]
- propertyName
  نوع: anything
propertyName
نوع: anything

top_p
نوع: number
حداقل:
0
حداکثر:
1
user
نوع: string
propertyName
نوع: anything

پاسخ‌ها

200
نوع: object · ChatCompletionResponse

تکمیل چت یا پاسخ جریان‌سازی
choices
نوع: array object[] · ChatChoice[]
الزامی
finish_reason
نوع: string | null
index
نوع: integer

Integer numbers.

logprobs
نوع: object | null
propertyName
نوع: anything
message
نوع: object · ChatMessage
content
تهی‌پذیر
الزامی
نوع: string
role
نوع: string فهرست مقادیر
الزامی
مقادیر
system
developer
user
assistant
tool
name
نوع: string
tool_call_id
نوع: string
tool_calls
نوع: array object[]
propertyName
نوع: anything
propertyName
نوع: anything
propertyName
نوع: anything
id
نوع: string
الزامی
object
نوع: string
الزامی

معمولاً chat.completion برای پاسخ‌های غیرجریان‌سازی.

created
نوع: integer قالب: int64

Signed 64-bit integers (long type).

model
نوع: string
system_fingerprint
نوع: string
usage
نوع: object · Usage

شیء مصرف ارائه‌دهنده. فیلدها بر اساس نقطه پایانی و ارائه‌دهنده متفاوت‌اند.

propertyName
نوع: anything
propertyName
نوع: anything
400
نوع: object · OpenAIErrorResponse

درخواست، مدل یا نگاشت ارائه‌دهنده نامعتبر

پاکت خطای سازگار با OpenAI. Router ممکن است code و message را بدون همه فیلدهای اختیاری بالادست شامل شود.
error
نوع: object
الزامی
message
نوع: string
الزامی
code
نوع: string | null
param
نوع: string | null
type
نوع: string

نوع خطای سازگار با OpenAI در صورت ارائه.

propertyName
نوع: anything
propertyName
نوع: anything
application/json
401
نوع: object · OpenAIErrorResponse

کلید API Felo نامعتبر است یا وجود ندارد.

پاکت خطای سازگار با OpenAI. Router ممکن است code و message را بدون همه فیلدهای اختیاری بالادست شامل شود.
error
نوع: object
الزامی
message
نوع: string
الزامی
code
نوع: string | null
param
نوع: string | null
type
نوع: string

نوع خطای سازگار با OpenAI در صورت ارائه.

propertyName
نوع: anything
propertyName
نوع: anything
application/json
402
نوع: object · OpenAIErrorResponse

موجودی ناکافی

پاکت خطای سازگار با OpenAI. Router ممکن است code و message را بدون همه فیلدهای اختیاری بالادست شامل شود.
error
نوع: object
الزامی
message
نوع: string
الزامی
code
نوع: string | null
param
نوع: string | null
type
نوع: string

نوع خطای سازگار با OpenAI در صورت ارائه.

propertyName
نوع: anything
propertyName
نوع: anything
application/json
403
نوع: object · OpenAIErrorResponse

حساب مجاز به استفاده از این مدل نیست. مدل‌های غیرفعال نیز پیش از فراخوانی‌های بالادست رد می‌شوند. درخواست‌ها و وظایف پذیرفته‌شده موجود ادامه می‌یابند.

پاکت خطای سازگار با OpenAI. Router ممکن است code و message را بدون همه فیلدهای اختیاری بالادست شامل شود.
error
نوع: object
الزامی
message
نوع: string
الزامی
code
نوع: string | null
param
نوع: string | null
type
نوع: string

نوع خطای سازگار با OpenAI در صورت ارائه.

propertyName
نوع: anything
propertyName
نوع: anything
application/json
429
نوع: object · OpenAIErrorResponse

سقف هزینه یا درخواست به پایان رسیده است

پاکت خطای سازگار با OpenAI. Router ممکن است code و message را بدون همه فیلدهای اختیاری بالادست شامل شود.
error
نوع: object
الزامی
message
نوع: string
الزامی
code
نوع: string | null
param
نوع: string | null
type
نوع: string

نوع خطای سازگار با OpenAI در صورت ارائه.

propertyName
نوع: anything
propertyName
نوع: anything
application/json
502
نوع: object · OpenAIErrorResponse

درخواست ارائه‌دهنده بالادست ناموفق بود

پاکت خطای سازگار با OpenAI. Router ممکن است code و message را بدون همه فیلدهای اختیاری بالادست شامل شود.
error
نوع: object
الزامی
message
نوع: string
الزامی
code
نوع: string | null
param
نوع: string | null
type
نوع: string

نوع خطای سازگار با OpenAI در صورت ارائه.

propertyName
نوع: anything
propertyName
نوع: anything
application/json
503
نوع: object · OpenAIErrorResponse

ارائه‌دهنده یا سرویس صورت‌حساب در دسترس نیست

پاکت خطای سازگار با OpenAI. Router ممکن است code و message را بدون همه فیلدهای اختیاری بالادست شامل شود.
error
نوع: object
الزامی
message
نوع: string
الزامی
code
نوع: string | null
param
نوع: string | null
type
نوع: string

نوع خطای سازگار با OpenAI در صورت ارائه.

propertyName
نوع: anything
propertyName
نوع: 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
}'

نمایش اسکیما

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

تکمیل چت یا پاسخ جریان‌سازی

ایجاد یک تکمیل چت

احراز هویتRequired

ایجاد یک تکمیل چت