Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

ایجاد یک پاسخ مدل

Felo API Support
MIT
سرور:https://openapi.felo.ai
کتابخانه‌های کلاینت
Shell Curl

ایجاد یک پاسخ مدل

​

نقطه پایانی سازگار با OpenAI Responses API. یک پاسخ موفق غیرجریان‌سازی از شکل شیء Responses استفاده می‌کند؛ وقتی stream=true باشد، نقطه پایانی رویدادهای SSE Responses را برمی‌گرداند. یک شیء Responses ناموفق می‌تواند حتی وقتی خود درخواست HTTP کامل شده است، از status=failed با error={code,message} استفاده کند.

هدرها
  • 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 (استاندارد) پشتیبانی می‌شود. مقادیر حذف‌شده، null، نام‌های مستعار و رشته‌های پشتیبانی‌نشده به default بازمی‌گردند؛ انواع دیگر HTTP 400 برمی‌گردانند. کانال‌ها و قیمت‌های پیکربندی‌شده بدون تغییر می‌مانند. APIهای متنی مقدار استاندارد ارائه‌دهنده را ارسال می‌کنند؛ 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