Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

ماڈل کا جواب بنائیں

سرور:https://openapi.felo.ai
کلائنٹ لائبریریاں

ماڈل کا جواب بنائیں

​

OpenAI Responses API سے مطابقت رکھنے والا endpoint۔ کامیاب غیر اسٹریمنگ جواب Responses آبجیکٹ کی شکل استعمال کرتا ہے؛ جب stream=true ہو تو endpoint Responses SSE ایونٹس واپس کرتا ہے۔ ناکام Responses آبجیکٹ status=failed کے ساتھ error={code,message} استعمال کر سکتا ہے، چاہے HTTP درخواست خود مکمل ہو چکی ہو۔

ہیڈرز
  • X-Felo-Channel
    قسم: string

    ترتیب شدہ، کوما سے الگ کیے گئے پبلک چینل کوڈز۔ default استعمال کرنے کے لیے یہ ہیڈر چھوڑ دیں؛ default کو تنہا ہی استعمال کرنا ہوگا۔ wallet موڈ میں default ماڈل کے مؤثر پبلک چینل کی ترتیب کو الٹی سمت میں اسکین کرتا ہے، غیر شائع شدہ یا غیر دستیاب چینلز کو نظر انداز کرتا ہے، اور پہلے دستیاب چینل کے پرووائیڈر کا انتخاب کرتا ہے۔ اس میں اسی اپ اسٹریم ماڈل ID اور سروس ٹیئر والے اس پرووائیڈر کے دستیاب endpoints شامل کیے جاتے ہیں۔ واضح چینلز کی توثیق کلائنٹ کی بتائی ہوئی ترتیب میں ہوتی ہے؛ صرف پہلے چینل کا پرووائیڈر گروپ جمع کیا جاتا ہے۔ دیگر پرووائیڈرز کی طرف کوئی خودکار fallback نہیں ہے۔ پرانے پرووائیڈر ہیڈرز چینل روٹنگ کو اوور رائیڈ نہیں کر سکتے۔

باڈی·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 پر fallback کرتے ہیں؛ دیگر اقسام HTTP 400 واپس کرتی ہیں۔ ترتیب شدہ چینلز اور قیمتیں تبدیل نہیں ہوتیں۔ Text APIs پرووائیڈر کی standard قدر بھیجتے ہیں؛ Decisions اور generation APIs اپ اسٹریم فیلڈ شامل نہیں کرتے۔

  • 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

      پرووائیڈر کا استعمال آبجیکٹ۔ فیلڈز endpoint اور پرووائیڈر کے لحاظ سے مختلف ہوتے ہیں۔

      • 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

    غلط یا غیر موجود Felo API کلید

    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