فهرست endpointهای وب‌سرویس
همهٔ مسیرها زیر نشانی پایهٔ https://gisoo.pro/api/v1 هستند و کلید را در هدر Authorization: Bearer می‌فرستید. پارامترها، پاسخ‌ها و نمونه‌کد هر کدام در مرجع تعاملی پایین همین صفحه آمده است.
مدل‌ها
فهرست مدل‌ها و قیمت‌ها؛ بدون کلید
-
GET /models فهرست مدل‌ها و قیمت‌ها
همهٔ مدل‌هایی که امروز فروخته می‌شوند، با قیمت دلاری.
-
GET /models/{id} مشخصات و قیمت یک مدل
متن و گفت‌وگو
Chat Completions، Responses و Completions
-
POST /chat/completions گفت‌وگو (Chat Completions)
همان قالب OpenAI.
-
POST /responses Responses API
Responses API از OpenAI، بدون تغییر.
-
POST /completions Completions (قالب قدیمی)
برای ابزارهای قدیمی.
-
POST /messages Messages (سازگار با Anthropic)
همان قالب Messages API از Anthropic، برای SDK رسمی Anthropic و Claude Code.
-
POST /messages/count_tokens برآورد توکن ورودی (سازگار با Anthropic)
برآورد تعداد توکن ورودی یک درخواست Messages، بدون فرستادن آن به مدل و بدون هزینه.
امبدینگ
تبدیل متن به بردار برای جست‌وجوی معنایی و RAG
-
POST /embeddings امبدینگ متن
تصویر
ساخت تصویر از توصیف متنی
-
POST /images/generations ساخت تصویر
خروجی همیشه base64 است (data[].b64_json).
صدا
گفتار به متن، ترجمهٔ صوت و متن به گفتار
-
POST /audio/transcriptions گفتار به متن
فایل را به شکل multipart/form-data در فیلد file بفرستید (حداکثر ۲۵ مگابایت: mp3، mp4، m4a، wav، webm، ogg).
-
POST /audio/translations ترجمهٔ صوت به متن انگلیسی
-
POST /audio/speech متن به گفتار
فایل صوتی (پیش‌فرض mp3) را مستقیم برمی‌گرداند.
-
POST /audio/voice-change تبدیل صدا
فایل صوتی را به شکل multipart/form-data در فیلد file بفرستید (حداکثر ۲۵ مگابایت).
ویدیو
ساخت ویدیو؛ کار ناهمگام
-
POST /videos شروع ساخت ویدیو
ساخت ویدیو یکی دو دقیقه طول می‌کشد، پس این مسیر فایل برنمی‌گرداند؛ یک «کار» با شناسهٔ vid_… برمی‌گرداند.
-
GET /videos ویدیوهای این پروژه
-
GET /videos/{id} وضعیت یک ویدیو
status: queued، in_progress، completed یا failed.
-
DELETE /videos/{id} لغو یا حذف ویدیو
ویدیویی که هنوز تحویل نشده لغو می‌شود و هزینه‌اش برمی‌گردد.
-
GET /videos/{id}/content دریافت فایل ویدیو
فایل MP4.
موسیقی
ساخت قطعهٔ موسیقی از توصیف
-
POST /audio/music ساخت موسیقی
یک قطعهٔ کامل را یک‌جا برمی‌گرداند (MP3 در قالب base64).
پایش محتوا
Moderations
-
POST /moderations پایش محتوا
قالب OpenAI Moderations.
حساب و مصرف
موجودی، محدودیت‌ها و گزارش مصرف
-
GET /me موجودی و محدودیت‌های همین کلید
-
GET /usage گزارش مصرف پروژه
پیش‌فرض ۳۰ روز اخیر، روزبه‌روز.
-
GET /requests/{id} وضعیت و هزینهٔ یک درخواست
شناسه همان id پاسخ یا هدر X-Request-Id است.
مدیریت پروژه‌ها و کلیدها
برای هر کاربر محصول شما یک پروژه و یک کلید با سقف هزینه و انقضای مشخص بسازید و تغییر دهید. با کلید مدیریت (`sk-ntz-mgmt-v1-…` یا `sk-gisoo-mgmt-v1-…`) کار می‌کند، نه با کلید مدل؛ آن را فقط روی سرور خودتان نگه دارید. فقط پروژه‌هایی را می‌بیند که با همین API ساخته شده‌اند. راهنمای کامل: صفحهٔ «API مدیریت پروژه‌ها و کلیدها» در مستندات.
-
GET /manage/account موجودی و وضعیت حساب
موجودی، شمارش پروژه‌ها و کلیدهای ساخته‌شده با این API و سقف‌های کاری.
-
GET /manage/projects فهرست پروژه‌ها
فقط پروژه‌های ساخته‌شده با API مدیریت؛ جدیدترین اول.
-
POST /manage/projects ساختن پروژه (و کلید اول)
پروژه و، اگر key را بفرستید، اولین کلیدش در یک تراکنش ساخته می‌شود.
-
GET /manage/projects/by-external/{external_id} پروژه با شناسهٔ خودتان
پروژه را با external_id پیدا می‌کند.
-
GET /manage/projects/{id} خواندن پروژه
یک پروژهٔ ساخته‌شده با API مدیریت.
-
PATCH /manage/projects/{id} تغییر پروژه
فقط فیلدهای فرستاده‌شده عوض می‌شوند.
-
DELETE /manage/projects/{id} بایگانی پروژه
بازگشت‌ناپذیر: همهٔ کلیدها باطل می‌شوند و پروژه خاموش و بایگانی می‌شود.
-
GET /manage/projects/{id}/usage مصرف پروژه
مصرف روزانه از جدول تجمیع؛ بعد از تسویهٔ هر درخواست به‌روز می‌شود.
-
GET /manage/projects/{id}/keys فهرست کلیدهای پروژه
همهٔ کلیدها، با باطل‌شده‌ها و منقضی‌شده‌ها؛ جدیدترین اول.
-
POST /manage/projects/{id}/keys ساختن کلید
spend_limit_usd الزامی است؛ کلیدی که با این API ساخته شود هیچ‌وقت بدون سقف نیست.
-
GET /manage/keys/{id} خواندن کلید
مشخصات یک کلید، بدون متن کامل آن.
-
PATCH /manage/keys/{id} تغییر کلید
سقف را با spend_limit_usd (مقدار مطلق) یا spend_limit_add_usd (افزودن اتمی) عوض کنید، هر دو با هم ۴۲۲ است.
-
DELETE /manage/keys/{id} باطل کردن کلید
بازگشت‌ناپذیر.
-
POST /manage/keys/{id}/rotate چرخش کلید
همان کلید (شناسه، سقف و مصرف) متن تازه می‌گیرد؛ متن قبلی همان لحظه از کار می‌افتد.
