v0.4.0

OpenAPI 3.1.0

إنشاء إكمال دردشة

Felo API Support

MIT

الخادم

https://openapi.felo.ai

مكتبات العملاء

Shell Curl

إنشاء إكمال دردشة

واجهة Chat Completions المتوافقة مع OpenAI. اضبط stream=true لتلقي أحداث Server-Sent Events. تتبع الاستجابة ومغلّف الأخطاء شكل Chat Completions/OpenAI المتوافق.

الرؤوس

X-Felo-Channel
النوع: string

رموز قنوات عامة مرتبة ومفصولة بفواصل. احذف هذه الترويسة لاستخدام default؛ ويجب استخدام default وحده. في وضع المحفظة، يفحص default ترتيب القنوات العامة الفعلية للنموذج بترتيب عكسي، ويتخطى القنوات غير المنشورة أو غير المتاحة، ويختار مزوّد أول قناة متاحة. ويشمل نقاط النهاية المتاحة من ذلك المزوّد ذات معرّف النموذج الأعلى ومستوى الخدمة نفسيهما. تُتحقق القنوات الصريحة بالترتيب الذي يحدده العميل؛ ولا تُقدَّم سوى مجموعة مزوّد القناة الأولى. لا يوجد رجوع تلقائي إلى مزوّدين آخرين. لا يمكن لترويسات المزوّد القديمة تجاوز توجيه القنوات.

الجسم·ChatCompletionRequest

مطلوب

application/json

messages
النوع: array object[] · ChatMessage[] 1…
مطلوب
- content
  يقبل null
  مطلوب
  النوع: 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 (standard). عند الحذف أو null أو الأسماء البديلة أو السلاسل غير المدعومة، يحدث رجوع إلى default؛ وتعيد الأنواع الأخرى HTTP 400. تبقى القنوات والأسعار المُهيَّأة دون تغيير. ترسل واجهات API النصية القيمة القياسية للمزوّد؛ وتحذف واجهات Decisions والتوليد حقل المنبع.
stop
يقبل null
النوع: 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
يقبل null
مطلوب
النوع: 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

إنشاء إكمال دردشة