مرجع API

نقاط اتصال

احراز هویت

توکن Bearer روی هر درخواست. کلیدها را فلاکس‌سی‌دی‌ان صادر می‌کند، به یک پروژه محدودند و دقیقاً یک‌بار هنگام ساخت به‌طور کامل نمایش داده می‌شوند.

Authorization: Bearer flux_live_7Yc2Kq9m4Rt8Wv1sHb3dPz6L

هدرهای پاسخ

روی هر پاسخ، از جمله پخش زنده و خطاها، تنظیم می‌شوند. کلاینت‌ها می‌توانند به آن‌ها تکیه کنند.

x-fluxcdn-request-id

با سطر مربوطه در بخش فعالیت مطابقت دارد. در درخواست‌های پشتیبانی آن را ذکر کنید.

x-fluxcdn-resolved-model

مدلی که واقعاً سرویس داده؛ وقتی از نام مستعار استفاده شده باشد با مدل درخواستی فرق دارد.

x-fluxcdn-provider

کدام ارائه‌دهنده سرویس داده است.

x-fluxcdn-region

از کدام منطقه سرویس داده شده است.

x-fluxcdn-attempts

چند نقطهٔ اتصال امتحان شده. بیشتر از ۱ یعنی جایگزینی رخ داده است.

x-fluxcdn-cost-micros

هزینهٔ درخواست برای شما، به میکرو صحیح.

پخش زنده

با تنظیم stream روی true، پاسخ به‌صورت رویدادهای ارسالی از سرور در قالب چانک OpenAI می‌آید و با data: [DONE] پایان می‌یابد. مصرف و تصمیم مسیریابی در آخرین چانک، پیش از پایان‌دهنده، می‌رسند.

data: {"id":"chatcmpl_…","object":"chat.completion.chunk",
       "choices":[{"index":0,"delta":{"content":"Hello"},"finish_reason":null}]}

data: {"id":"chatcmpl_…","object":"chat.completion.chunk",
       "choices":[{"index":0,"delta":{},"finish_reason":"stop"}],
       "usage":{"prompt_tokens":12,"completion_tokens":48,"total_tokens":60},
       "routing":{"resolved_model":"anthropic/claude-sonnet-4.5","provider":"Anthropic",
                  "region":"us-east","attempts":1,"customer_cost_micros":756}}

data: [DONE]

قرارداد خطا

هر شکست بالادستی به یک ساختار و یک مجموعهٔ بستهٔ انواع نگاشت می‌شود، بنابراین منطق تلاش دوباره به شاخه‌ای جداگانه برای هر فروشنده نیاز ندارد. پرچم retryable می‌گوید آیا تکرار عیناً همان درخواست می‌تواند موفق شود یا نه.

{
  "error": {
    "type": "upstream_unavailable",
    "message": "All endpoints for this model are unavailable.",
    "request_id": "req_8Kd2Qm",
    "retryable": true,
    "attempts": 3
  }
}