Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

إنشاء استجابة نموذج

Felo API Support
MIT
الخادم:https://openapi.felo.ai
مكتبات العملاء
Shell Curl

إنشاء استجابة نموذج

​

نقطة نهاية متوافقة مع واجهة Responses من OpenAI. تستخدم الاستجابة الناجحة غير المتدفقة شكل كائن Responses؛ وعندما تكون stream=true تعيد نقطة النهاية أحداث SSE الخاصة بـ Responses. يمكن لكائن Responses الفاشل أن يستخدم status=failed مع error={code,message} حتى عندما يكتمل طلب HTTP نفسه.

الرؤوس
  • X-Felo-Channel
    النوع: string

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

الجسم·ResponsesRequest
مطلوب
application/json
  • input
    مطلوب
    • النوع: string
  • model
    النوع: string
    مطلوب
  • include
    النوع: array string[]
  • instructions
    النوع: string
  • max_output_tokens
    النوع: integer
    الحد الأدنى:  
    1

    Integer numbers.

  • metadata
    النوع: object
    • propertyName
      النوع: anything
  • previous_response_id
    النوع: string
  • reasoning
    النوع: object
    • propertyName
      النوع: anything
  • service_tier
    النوع: string | null

    لا يُدعم حاليًا سوى default (standard). عند الحذف أو null أو الأسماء البديلة أو السلاسل غير المدعومة، يحدث رجوع إلى default؛ وتعيد الأنواع الأخرى HTTP 400. تبقى القنوات والأسعار المُهيَّأة دون تغيير. ترسل واجهات API النصية القيمة القياسية للمزوّد؛ وتحذف واجهات Decisions والتوليد حقل المنبع.

  • store
    النوع: boolean
  • stream
    النوع: boolean
  • temperature
    النوع: number
    الحد الأدنى:  
    0
  • propertyName
    النوع: anything
  • text
    النوع: object
    • propertyName
      النوع: anything
  • tool_choice
    • النوع: string
  • tools
    النوع: array object[]
    • propertyName
      النوع: anything
  • top_p
    النوع: number
    الحد الأدنى:  
    0
    الحد الأقصى:  
    1
  • propertyName
    النوع: anything
الاستجابات
  • 200
    النوع: object · ResponsesResponse

    كائن استجابة أو أحداث استجابة بث

    • id
      النوع: string
      مطلوب
    • object
      ثابت:  
      response
      مطلوب
    • status
      النوع: string تعداد
      مطلوب
      القيم
      • completed
      • failed
      • in_progress
      • cancelled
      • queued
      • incomplete
    • error
      النوع: object · ResponsesError
      • code
        النوع: string
        مطلوب
      • message
        النوع: string
        مطلوب
      • propertyName
        النوع: anything
    • metadata
      النوع: object
      • propertyName
        النوع: anything
    • model
      النوع: string
    • output
      النوع: array object[]
      • propertyName
        النوع: anything
    • output_text
      النوع: 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
Request Example for post/api/v1/responses
curl https://openapi.felo.ai/api/v1/responses \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "gpt-5.5",
  "input": "Explain why the sky is blue in one sentence.",
  "stream": false
}'

{
  "id": "string",
  "object": "response",
  "status": "completed",
  "output": [
    {
      "additionalProperty": "anything"
    }
  ],
  "output_text": "string",
  "error": {
    "code": "string",
    "message": "string",
    "additionalProperty": "anything"
  },
  "usage": {
    "additionalProperty": "anything"
  },
  "model": "string",
  "metadata": {
    "additionalProperty": "anything"
  },
  "additionalProperty": "anything"
}

كائن استجابة أو أحداث استجابة بث

Create a model response