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 שנכשל יכול להשתמש ב-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 (סטנדרטי). ערך שהושמט, null, כינויים ומחרוזות לא נתמכות נופלים חזרה ל-default; סוגים אחרים מחזירים HTTP 400. הערוצים והמחירים המוגדרים נשארים ללא שינוי. ממשקי טקסט שולחים את הערך הסטנדרטי של הספק; ממשקי 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
      const:  
      response
      חובה
    • status
      סוג: string enum
      חובה
      ערכים
      • 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