پرش به محتوا

مستندات API

PolAI با API سازگار با OpenAI در دسترس است. نمونه‌ها از نام POLAI_API_KEY استفاده می‌کنند. کلید واقعی را از پنل خودتان جایگزین کنید.

شروع سریع

یک حساب بسازید، کلید API را در پنل ایجاد کنید، و درخواست را به نشانی پایه بفرستید.

نشانی پایه

نشانی پایه
https://api.polai.ir/v1
نشانی پایه

احراز هویت

کلید API را در سربرگ Authorization بفرستید.

سربرگ
Authorization: Bearer $POLAI_API_KEY
سربرگ

کلید API

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

ساخت حساب و کلید 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

bash
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": "سلام"}
    ]
  }'
bash

Python

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": "سلام"},
    ],
)
python

JavaScript

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);
javascript

جریان پاسخ

مقدار stream را true بگذارید و هر قطعه را همان لحظه بخوانید.

python
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="")
python

فهرست مدل‌ها

GET /v1/models

مدل‌های در دسترس همان کلید API را برمی‌گرداند.

bash
curl https://api.polai.ir/v1/models \
  -H "Authorization: Bearer $POLAI_API_KEY"
bash

کلید API را محرمانه نگه دارید.

آن را در کد سمت مرورگر، مخزن عمومی، یا برنامهٔ سمت کاربر قرار ندهید.

در محیط عملیاتی، کلید را در متغیر محیطی یا مخزن رمز سمت سرور نگه دارید.