Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

چیٹ کمپلیشن بنائیں

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

چیٹ کمپلیشن بنائیں

​

OpenAI سے مطابقت رکھنے والا Chat Completions API۔ Server-Sent Events وصول کرنے کے لیے stream=true سیٹ کریں۔ جواب اور خرابی کا لفافہ Chat Completions/OpenAI سے مطابقت رکھنے والی شکل کی پیروی کرتا ہے۔

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

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

باڈی·ChatCompletionRequest
لازمی
application/json
  • messages
    قسم: array object[] · ChatMessage[] 1…
    لازمی
    • content
      null کی اجازت
      لازمی
      • قسم: string
    • role
      قسم: string enum
      لازمی
      اقدار
      • 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 پر fallback کرتے ہیں؛ دیگر اقسام HTTP 400 واپس کرتی ہیں۔ ترتیب شدہ چینلز اور قیمتیں تبدیل نہیں ہوتیں۔ Text APIs پرووائیڈر کی standard قدر بھیجتے ہیں؛ Decisions اور generation APIs اپ اسٹریم فیلڈ شامل نہیں کرتے۔

  • 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 enum
          لازمی
          اقدار
          • 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

      پرووائیڈر کا استعمال آبجیکٹ۔ فیلڈز 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/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"
}
Create a chat completion