۱۰۰ هزار تومان هدیهٔ ثبت‌نام، تا ۱ میلیونبا ثبت‌نام گردونهٔ هدیه را بچرخان: دست‌کم ۱۰۰٬۰۰۰ تومان و تا ۱٬۰۰۰٬۰۰۰ تومان اعتبار هدیه، بدون کارت بانکیگردونهٔ هدیه۱ میلیون برای تو، ۱ میلیون برای دوستتدوستانت را دعوت کن: برای هر دوستی که فعال شود ۱٬۰۰۰٬۰۰۰ تومان اعتبار هدیه می‌گیری و خودش هم ۱٬۰۰۰٬۰۰۰ تومانجوایز
1xAi
مستندات API

احراز هویت در API: کلید و هدرها

هر درخواست باید کلید 1xai-* را در یک هدر بفرستد: Authorization: Bearer، x-api-key یا x-goog-api-key. هر سه روی همهٔ مسیرها پذیرفته می‌شوند، پس کتابخانه‌های رسمی OpenAI‏، Anthropic و Google بدون تغییر کار می‌کنند. کلید در نشانی (?key=) خوانده نمی‌شود. کلید نادرست، باطل یا منقضی پاسخ 401 می‌گیرد.

آخرین به‌روزرسانی:

فهرست مستندات

احراز هویت · ۱

سه هدر، یک کلید

http
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-* را فقط در سرور نگه دار. برای تماس صوتی زنده از مرورگر یا اپ، سرور تو یک کلید موقت می‌گیرد و فقط همان را به کاربر می‌دهد (صوت زنده). برای بقیهٔ مسیرها درخواست را از سرور خودت بفرست.