مستندات API
PolAI با API سازگار با OpenAI در دسترس است. نمونهها از نام POLAI_API_KEY استفاده میکنند. کلید واقعی را از پنل خودتان جایگزین کنید.
شروع سریع
یک حساب بسازید، کلید API را در پنل ایجاد کنید، و درخواست را به نشانی پایه بفرستید.
نشانی پایه
https://api.polai.ir/v1احراز هویت
کلید API را در سربرگ Authorization بفرستید.
Authorization: Bearer $POLAI_API_KEYکلید API
متن کامل کلید فقط یکبار، هنگام ساخت در پنل، نشان داده میشود. این صفحه کلید حساب شما را نشان نمیدهد.
مدلها
شناسهٔ مدل را از فهرست مدلها بردارید و در فیلد model بگذارید. نمونهٔ این صفحه از MODEL_NAME استفاده میکند.
تکمیل گفتگو
POST /v1/chat/completions
Authorization: Bearer $POLAI_API_KEY
Content-Type: application/json{
"model": "MODEL_NAME",
"messages": [
{
"role": "user",
"content": "سلام"
}
]
}cURL
curl https://api.polai.ir/v1/chat/completions \
-H "Authorization: Bearer $POLAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "MODEL_NAME",
"messages": [
{"role": "user", "content": "سلام"}
]
}'Python
from openai import OpenAI
client = OpenAI(
api_key="POLAI_API_KEY",
base_url="https://api.polai.ir/v1",
)
create = client.chat.completions.create
response = create(
model="MODEL_NAME",
messages=[
{"role": "user", "content": "سلام"},
],
)JavaScript
import OpenAI from "openai";
const client = new OpenAI({
apiKey: process.env.POLAI_API_KEY,
baseURL: "https://api.polai.ir/v1",
});
const response = await client.chat.completions.create({
model: "MODEL_NAME",
messages: [
{ role: "user", content: "سلام" },
],
});
console.log(response.choices[0].message.content);جریان پاسخ
مقدار stream را true بگذارید و هر قطعه را همان لحظه بخوانید.
from openai import OpenAI
client = OpenAI(
api_key="POLAI_API_KEY",
base_url="https://api.polai.ir/v1",
)
stream = client.chat.completions.create(
model="MODEL_NAME",
messages=[
{"role": "user", "content": "یک داستان کوتاه بگو."},
],
stream=True,
)
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")فهرست مدلها
GET /v1/models
مدلهای در دسترس همان کلید API را برمیگرداند.
curl https://api.polai.ir/v1/models \
-H "Authorization: Bearer $POLAI_API_KEY"کلید API را محرمانه نگه دارید.
آن را در کد سمت مرورگر، مخزن عمومی، یا برنامهٔ سمت کاربر قرار ندهید.
در محیط عملیاتی، کلید را در متغیر محیطی یا مخزن رمز سمت سرور نگه دارید.