رفتن به محتوا
سارویتوسعه‌دهندگان
مستندات/شروع کنید

اولین درخواست شما

با Python، TypeScript یا cURL یک پاسخ بگیرید و مصرف آن را در کنسول پیدا کنید.

۱. پروژه و کلید بسازید

با حساب ساروی وارد شوید و یک پروژه برای برنامه‌تان بسازید. در کلیدهای API، دسترسی‌های responses:write و models:read را انتخاب کنید. برای دیدن مصرف از برنامه، usage:read را هم اضافه کنید.

کلید کامل فقط یک بار نمایش داده می‌شود. آن را روی سرور در متغیر محیطی SAROVI_API_KEY بگذارید؛ کلید نباید وارد کد مرورگر یا مخزن عمومی شود.

bash
export SAROVI_API_KEY="YOUR_SAROVI_API_KEY"

در PowerShell از $env:SAROVI_API_KEY="YOUR_SAROVI_API_KEY" استفاده کنید.

۲. کتابخانه را نصب کنید و اجرا کنید

نمونهٔ Python را در example.py ذخیره و با python example.py اجرا کنید. برای TypeScript، نمونه را در example.mjs بگذارید و با node example.mjs اجرا کنید. دستور نصب زیر نمونه دیده می‌شود. cURL به نصب SDK نیاز ندارد.

Python
from openai import OpenAI
import os

client = OpenAI(
    api_key=os.environ["SAROVI_API_KEY"],
    base_url="https://api.sarovi.ir/v1",
    max_retries=0,
)

response = client.responses.create(
    model="z-ai/glm-5.3-flash",
    input="یک ایده برای شروع بنویس.",
    max_output_tokens=512,
)
print(response.output_text)
pip install openai

مقدار output_text متن پاسخ است؛ مثلاً «یک دستیار برای پاسخ‌گویی به پرسش‌های مشتریان بسازید.» متن دقیق هر بار می‌تواند متفاوت باشد. شناسهٔ response.id شناسهٔ پاسخ مدل است؛ شناسهٔ پیگیری درخواست در هدر X-Request-ID قرار دارد.

۳. درخواست و هزینه را ببینید

در گزارش درخواست‌ها، پروژهٔ همین کلید را انتخاب کنید. مدل، زمان اجرا، نتیجه و اعتبار مصرفی را بررسی کنید. اعتبار از موجودی مشترک حساب رزرو می‌شود و بعد از پایان تسویه می‌شود؛ رزرو موقت هزینهٔ نهایی نیست.

اگر وضعیت پاسخ incomplete بود، علت توقف را بررسی کنید. افزایش max_output_tokens یک درخواست تازه است و ادامهٔ تضمین‌شدهٔ همان متن نیست.

اگر درخواست اجرا نشد

وضعیتقدم بعدی
401نام متغیر محیطی و معتبر بودن کلید را بررسی کنید.
403مجوز responses:write و دسترسی پروژه را بررسی کنید.
402موجودی و سقف پروژه یا کلید را در کنسول ببینید.
429به‌اندازهٔ Retry-After صبر کنید.
قطع اتصالپیش از ارسال دوباره، گزارش همان درخواست را بررسی کنید.

تلاش مجدد خودکار در نمونه خاموش است. برای عملیات پولی، راهنمای تلاش مجدد و کلید ثابت Idempotency-Key را بخوانید.

قدم بعدی

قرارداد API 1.6.0 · تاریخچهٔ تغییرات