مستندات API
احراز هویت در API: کلید و هدرها
هر درخواست باید کلید 1xai-* را در یک هدر بفرستد: Authorization: Bearer، x-api-key یا x-goog-api-key. هر سه روی همهٔ مسیرها پذیرفته میشوند، پس کتابخانههای رسمی OpenAI، Anthropic و Google بدون تغییر کار میکنند. کلید در نشانی (?key=) خوانده نمیشود. کلید نادرست، باطل یا منقضی پاسخ 401 میگیرد.
آخرین بهروزرسانی:
فهرست مستندات
مسیرهای API
حساب، کلید و تیم
احراز هویت · ۱
سه هدر، یک کلید
Authorization: Bearer 1xai-XXXXXXXXXXXXXXXXXXXXXXXX
x-api-key: 1xai-XXXXXXXXXXXXXXXXXXXXXXXX
x-goog-api-key: 1xai-XXXXXXXXXXXXXXXXXXXXXXXX| هدر | چه کسی آن را میفرستد |
|---|---|
Authorization: Bearer | کتابخانههای OpenAI و هر ابزار سازگار با OpenAI |
x-api-key | کتابخانهٔ رسمی Anthropic |
x-goog-api-key | کتابخانهٔ رسمی Google GenAI |
- اگر
Authorizationفرستاده شده باشد همان خوانده میشود؛ دو هدر دیگر فقط وقتی خوانده میشوند کهAuthorizationنباشد. - کلید در پارامتر نشانی (
?key=، که بعضی نمونههای Google به کار میبرند) خوانده نمیشود و چنین درخواستی401میگیرد. کتابخانهٔ Google را با هدر تنظیم کن. - یک کلید روی همهٔ مسیرها کار میکند:
/v1،/anthropic،/geminiو API حساب.
احراز هویت · ۲
پاسخهای 401
| کد | معنی |
|---|---|
missing_api_key | کلیدی در Authorization، x-api-key یا x-goog-api-key فرستاده نشده |
invalid_api_key | کلیدی که 1xAi نمیشناسد |
account_disabled | کلید شناخته شده ولی حساب آن غیرفعال است |
key_revoked | کلید باطل یا منقضی شده |
key_capped | کلید به سقف خرج خودش رسیده |
workspace_limit | سقف ماهانهٔ فضای کاری یا عضو پر شده |
همهٔ کدها در مرجع خطاها هستند.
احراز هویت · ۳
مرورگر و اپ موبایل
کلید 1xai-* را فقط در سرور نگه دار. برای تماس صوتی زنده از مرورگر یا اپ، سرور تو یک کلید موقت میگیرد و فقط همان را به کاربر میدهد (صوت زنده). برای بقیهٔ مسیرها درخواست را از سرور خودت بفرست.