مستندات
دریافت کلید API
API هیبانا سازگار با OpenAI است
نیازی به کتابخانهٔ اختصاصی نیست. همان SDK رسمی OpenAI را نصب کنید و فقط آدرس پایه (base URL) و کلید API را عوض کنید، بقیهٔ کد شما دستنخورده کار میکند.
- به داشبورد کلیدهای API بروید.
- روی دکمه "کلیدهای وبسرویس" کلیک کنید.
- روی دکمه "ایجاد کلید جدید" کلیک کنید.
- یک نام برای کلید انتخاب کنید.
- کلید API را کپی کنید
کلید فقط یکبار نمایش داده میشود؛ آن را جایی امن ذخیره کنید. جزئیات نگهداری و چرخاندن کلید در صفحهٔ احراز هویت آمده است.
آدرس پایه و هدرها
هر درخواست به سه چیز نیاز دارد: آدرس پایه، کلید API در هدر Authorization، و کد مدلی که میخواهید صدا بزنید. آدرس پایه این است:
https://api-ai.hibanacloud.ir/v1| مورد | مقدار | توضیح |
|---|---|---|
| Base URL | https://api-ai.hibanacloud.ir/v1 | همان چیزی که در SDK به آن base_url یا baseURL میگویند. |
| Authorization | Bearer YOUR_API_KEY | کلید API شما، با پیشوند Bearer و یک فاصله. |
| Content-Type | application/json | برای هر درخواستی که بدنهٔ JSON دارد. |
| model | gpt-5-nano | کد مدل. فهرست کامل در صفحهٔ لیست مدلها. |
اولین فراخوانی
کوتاهترین چیزی که کار میکند، کلید خود را جایگزین کنید و همین را در ترمینال اجرا کنید:
curl https://api-ai.hibanacloud.ir/v1/chat/completions \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "gpt-5-nano", "messages": [{"role": "user", "content": "سلام!"}] }'همان درخواست، اینبار با کتابخانهٔ زبان دلخواه شما:
نصب کتابخانه:
pip install openaiکد نمونه:
from openai import OpenAI client = OpenAI( base_url="https://api-ai.hibanacloud.ir/v1", api_key="YOUR_API_KEY") response = client.chat.completions.create( model="gpt-5-nano", messages=[ {"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "سلام! چطوری؟"} ]) print(response.choices[0].message.content)پاسخ مورد انتظار
{ "id": "chatcmpl-abc123", "object": "chat.completion", "created": 1677652288, "model": "gpt-5-nano", "choices": [{ "index": 0, "message": { "role": "assistant", "content": "سلام! من خوبم، ممنون که پرسیدی. تو چطوری؟" }, "finish_reason": "stop" }], "usage": { "prompt_tokens": 20, "completion_tokens": 15, "total_tokens": 35, "cost_rial": 150 }}متن پاسخ در choices[0].message.content است. فیلد usage.cost_rial هزینهٔ همین درخواست به ریال است؛ نحوهٔ محاسبهٔ آن در قیمتگذاری و صورتحساب توضیح داده شده است.
اگر بهجای این پاسخ خطا گرفتید: خطای 401 یعنی هدر Authorization درست نیست، 402 یعنی موجودی کافی نیست و 429 یعنی به سقف نرخ درخواست رسیدهاید. هر سه در مدیریت خطاها و حل مشکلات با راهحل آمدهاند.
گامهای بعدی
- مشاهده لیست کامل مدلها - انتخاب مدل مناسب برای نیاز شما
- استفاده از Streaming - دریافت پاسخ به صورت تدریجی
- ارسال تصویر - تحلیل تصویر با مدلهای Vision
- تولید تصویر از متن (ساخت تصویر با یک درخواست
- محدودیت نرخ درخواست) سقفها و رفتار درست هنگام رسیدن به آنها