اولین درخواست API: از کلید تا پاسخ در یک دقیقه
کلید کامل فقط یک بار، هنگام ساخت، نشان داده میشود؛ اگر آن را نداری یک کلید تازه بساز. بعد یکی از سه نمونهٔ پایین را اجرا کن: همان کتابخانهٔ OpenAI با آدرس پایهٔ https://1xai.ir/v1. سادهتر از آن، در کلیدهای API دکمهٔ «امتحانش کن» یک درخواست واقعی و کوتاه با کلید خودت میفرستد و پاسخ و هزینهاش را نشان میدهد.
آخرین بهروزرسانی:
فهرست مستندات
مسیرهای API
حساب، کلید و تیم
اولین درخواست · ۱
کلید
- هر حساب هنگام ثبتنام یک کلید «Default» میگیرد، اما متن کامل هیچ کلیدی دوباره نشان داده نمیشود: ما فقط اثر درهمشدهٔ آن را نگه میداریم. اگر کلید را جایی نگه نداشتهای، در کلیدهای API یک کلید تازه بساز و همان لحظه کپیاش کن (کلیدها و امنیت).
- کلید با
1xai-شروع میشود. آن را در کد یا متغیر محیطی نگه دار، نه در نشانی صفحه یا کد سمت مرورگر.
اولین درخواست · ۲
درخواست
بهجای 1xai-... کلیدت را بگذار. مدل gpt-4o-mini سریع و ارزان است و اعتبار هدیهٔ ثبتنام آن را میپردازد؛ برای مدلهای دیگر فقط فیلد model را عوض کن.
curl https://1xai.ir/v1/chat/completions \
-H "Authorization: Bearer 1xai-..." \
-H "Content-Type: application/json" \
-d '{"model":"gpt-4o-mini","messages":[{"role":"user","content":"سلام"}]}'کتابخانهٔ رسمی OpenAI (pip install openai)
from openai import OpenAI
client = OpenAI(base_url="https://1xai.ir/v1", api_key="1xai-...")
resp = client.chat.completions.create(
model="gpt-4o-mini",
messages=[{"role": "user", "content": "سلام"}],
)
print(resp.choices[0].message.content)بستهٔ openai در npm (npm install openai)
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://1xai.ir/v1", apiKey: "1xai-..." });
const resp = await client.chat.completions.create({
model: "gpt-4o-mini",
messages: [{ role: "user", content: "سلام" }],
});
console.log(resp.choices[0].message.content);اولین درخواست · ۳
پاسخ و هزینه
- پاسخ همان شکل پاسخ OpenAI را دارد: متن در
choices[0].message.contentاست. - هدر
X-1xai-Cost-Tomanمیگوید همین درخواست چند تومان هزینه داشت وX-Request-Idشناسهٔ آن است؛ همان درخواست با همان شناسه در لاگ درخواستها هست (فرادادهٔ پاسخ). - دکمهٔ «امتحانش کن» در داشبورد حداکثر ۶۰ توکن پاسخ میخواهد و پیش از فرستادن، سقف هزینه را با قیمت همان روز نشان میدهد؛ این سقف همیشه کمتر از ۱۰۰ تومان است. هزینه مثل هر درخواست دیگری از اعتبار هدیه یا کیف پول کم میشود.
اولین درخواست · ۴
اگر کار نکرد
| کد | یعنی | چه کنی |
|---|---|---|
401 | کلید پذیرفته نشد | کلید را کامل و بدون فاصله کپی کن؛ اگر باطل یا منقضی شده، کلید تازه بساز. |
402 | اعتبار کافی نیست | کیف پول را شارژ کن یا مدلی بردار که اعتبار هدیهات میپردازد. |
403 | محدودیتهای کلید اجازه نداد | فهرست مدلها، نشانیهای IP یا دامنهٔ دسترسی کلید را ببین (محدودیتهای کلید). |
429 | سقف نرخ پر شد | چند ثانیه بعد دوباره بفرست؛ سقف هر کلید ۱٬۰۰۰ درخواست در دقیقه است (محدودیت نرخ). |
همهٔ کدها و متن خطاها در خطاها است. اگر باز هم کار نکرد، شناسهٔ X-Request-Id را در پشتیبانی بفرست.
اولین درخواست · ۵
قدم بعد
- شروع سریع: از ساخت حساب تا آدرسهای پایهٔ Anthropic و Gemini.
- مدلها: همهٔ مدلها با قیمت تومانی.
- پاسخ جریانی: متن را کلمهبهکلمه بگیر.
- کتابخانهها: Python و Node و ابزارهای دیگر.