مرجع API
متن درخواست و پاسخ همان قالب هر سازنده است و بی‌تغییر عبور می‌کند؛ مرجع هرکدام در زیر پیوند شده است. این صفحه آنچه مال وِیل است را می‌پوشاند.
مسیرها
| مسیر | قالب متن | کارش |
|---|---|---|
POST /v1/chat/completions | OpenAI Chat Completions | تکمیل گفت‌وگو، جاری یا یکجا. |
POST /v1/responses | OpenAI Responses | یک پاسخ، جاری یا یکجا. |
POST /v1/responses/compact | OpenAI Responses | یک گفت‌وگوی بلند را فشرده می‌کند (روی مدل‌هایی که خودشان پشتیبانی می‌کنند). |
POST /v1/messages | Anthropic Messages | یک پیام، جاری یا یکجا. |
POST /v1/messages/count_tokens | Anthropic Messages | توکن‌ها را می‌شمارد. رایگان. |
POST /v1/embeddings | OpenAI Chat Completions | بردارهای معنایی. |
POST /v1/images/generations | OpenAI Chat Completions | تصویر می‌سازد. به ازای هر تصویر برگشتی، یا توکن‌های تصویری که مدل گزارش می‌کند، حساب می‌شود. |
POST /v1/images/edits | OpenAI Chat Completions | تصویر را ویرایش می‌کند (بارگذاری چندبخشی). مثل ساخت تصویر حساب می‌شود، به‌اضافهٔ توکن‌های تصویر ورودی. |
POST /v1/audio/speech | OpenAI Chat Completions | متن را به صدا تبدیل می‌کند. به ازای هر نویسهٔ ورودی حساب می‌شود. |
POST /v1/audio/transcriptions | OpenAI Chat Completions | صدا را به متن تبدیل می‌کند (بارگذاری چندبخشی). با توکن صوتی یا ثانیه حساب می‌شود؛ response_format را json یا verbose_json بگذارید. |
POST /v1/videos | OpenAI Videos | ساخت یک ویدیو را آغاز می‌کند. با GET پیشرفتش را می‌خوانید (یا ویدیوهایتان را فهرست می‌کنید) و با DELETE پاکش می‌کنید. |
GET /v1/videos/{id}/content | OpenAI Videos | ویدیوی آماده را دریافت می‌کند؛ مستقیم از ارائه‌دهنده جریان می‌یابد. |
GET /v1/realtime | OpenAI Realtime | نشست صوتی بلادرنگ روی WebSocket (wss). کلید را در سرآیند بفرستید، یا از مرورگر به‌صورت زیرپروتکل openai-insecure-api-key. |
POST /v1/files | OpenAI Batch | ورودی یک دسته را بارگذاری می‌کند (purpose batch، فایل JSONL از درخواست‌های /v1/chat/completions). خواندن، فهرست و حذف همانند API فایل‌های OpenAI کار می‌کنند. |
GET /v1/files/{id}/content | OpenAI Batch | یک فایل را دریافت می‌کند: ورودی، نتیجه‌ها یا خطاهای یک دسته. |
POST /v1/batches | OpenAI Batch | دسته‌ای را از فایل بارگذاری‌شده آغاز می‌کند. با GET دسته‌ها را فهرست می‌کنید و هر کدام را می‌خوانید. |
POST /v1/batches/{id}/cancel | OpenAI Batch | دسته را لغو می‌کند. هزینهٔ درخواست‌هایی که اجرا شده‌اند گرفته می‌شود و بقیه رایگان‌اند. |
POST /v1/messages/batches | Anthropic Message Batches | دسته‌ای از درخواست‌های Messages را آغاز می‌کند. خواندن و فهرست، لغو و حذف همانند API Anthropic کار می‌کنند. |
GET /v1/messages/batches/{id}/results | Anthropic Message Batches | نتیجه‌های دستهٔ پایان‌یافته را دریافت می‌کند (JSONL). |
POST /v1beta/models/{model}:generateContent | Gemini | محتوا می‌سازد. |
POST /v1beta/models/{model}:streamGenerateContent | Gemini | محتوا را جاری می‌سازد. |
GET /v1/models | وِیل | هر مدلی که می‌توانید صدا بزنید، با محدودیت‌ها و قیمت‌ها. رایگان. |
GET /v1beta/models | Gemini | همان فهرست، به شکل Gemini. رایگان. |
GET /v1/generations/{id} | وِیل | مدل، توکن‌ها و هزینهٔ یک درخواست گذشته. رایگان. |
GET /v1/key | وِیل | محدودیت‌ها و هزینهٔ این دورهٔ کلیدِ فرستنده. رایگان. |
دسته‌ها
هر دسته تا ۱۰٬۰۰۰ درخواست به یک مدل است که ظرف ۲۴ ساعت با قیمت دسته‌ای سازنده پاسخ می‌گیرد؛ برای سازنده‌هایی که آن را ارائه می‌کنند، نصف قیمت فهرست. فقط مدل‌هایی که فهرست قیمتشان نرخ دسته‌ای دارد دسته می‌پذیرند. هنگام آغاز، وِیل بیشترین هزینهٔ ممکن کل دسته را کنار می‌گذارد؛ در پایان، فقط هزینهٔ درخواست‌هایی را می‌پردازید که اجرا شده‌اند، هر کدام با نرخ دسته‌ای، و باقی مبلغ آزاد می‌شود. هر درخواست در گزارش‌ها و مصرف دیده می‌شود.
دسته پس از پاسخ به درخواست شما اجرا می‌شود، پس درخواست‌ها و نتیجه‌هایش با کلید سازمان شما رمزنگاری‌شده نگه داشته می‌شوند: تا یک ساعت پس از دریافت نتیجه‌ها، یا اگر هرگز دریافتشان نکنید، تا ۷۲ ساعت پس از پایان دسته. فایل بارگذاری‌شده‌ای که هیچ دسته‌ای را آغاز نکند پس از یک روز پاک می‌شود.
ویدیو و بلادرنگ
هزینهٔ ویدیو به ازای هر ثانیه و بسته به ابعادش حساب می‌شود. هنگام آغاز، وِیل بهای همهٔ ثانیه‌هایی را که خواسته‌اید کنار می‌گذارد؛ وقتی ارائه‌دهنده کار را تمام کند، فقط ثانیه‌هایی را می‌پردازید که ساخته شده‌اند، و ویدیویی که ناموفق باشد رایگان است. وِیل نه پرامپت را نگه می‌دارد، نه تصویر مرجع و نه ویدیو را: ویدیو هنگام دریافت مستقیم از ارائه‌دهنده به شما می‌رسد.
نشست بلادرنگ هنگام باز شدن مبلغی را کنار می‌گذارد و برای توکن‌های متنی و صوتی هر پاسخ، ورودی و خروجی، هزینه می‌گیرد. وقتی هزینه به آن مبلغ برسد، وِیل نشست را با یک رویداد خطا می‌بندد؛ برای ادامه نشست تازه‌ای باز کنید. نشست هر طور پایان یابد، حتی با قطع اتصال، فقط هزینهٔ پاسخ‌هایی را می‌پردازید که ساخته شده‌اند.
سرآیندها
Authorization / x-api-key / x-goog-api-key | کلید وِیل شما، در هر سرآیندی که برنامه‌تان می‌فرستد. |
|---|---|
HTTP-Referer | اختیاری. نشانی برنامهٔ شما، که روی درخواست در کنسول نشان داده می‌شود. |
X-Title | اختیاری. نام برنامهٔ شما، که روی درخواست در کنسول نشان داده می‌شود. |
x-veil-cost-usd | به پاسخ‌های غیرجاری افزوده می‌شود: هزینهٔ درخواست به دلار. |
x-veil-provider | افزوده می‌شود: ارائه‌دهنده‌ای که پاسخ داد. |
x-veil-generation-id | افزوده می‌شود: شناسهٔ درخواست، برای /v1/generations و کنسول. |
x-veil-estimated | وقتی افزوده می‌شود که شمار توکن را وِیل برآورد کرده باشد، نه ارائه‌دهنده. |
خطاها
خطاها در قالب خطای خود برنامهٔ شما و با یکی از این وضعیت‌ها برمی‌گردند:
| 400 | درخواست نادرست است، یا هیچ ارائه‌دهنده‌ای با کف حریم خصوصی شما جور نیست؛ پیام می‌گوید کدام. |
|---|---|
| 401 | کلیدی نیست، یا کلید ناشناخته، باطل‌شده یا منقضی است. |
| 402 | اعتبار برای این درخواست کافی نیست. |
| 403 | این کلید اجازهٔ استفاده از آن مدل یا از این نشانی را ندارد. |
| 404 | مدل ناشناخته است، یا قیمتی برایش در کار نیست. |
| 413 | متن درخواست بیش از اندازه بزرگ است. |
| 429 | درخواست‌های این کلید بیش از حد است، یا سقف هزینه یا بودجهٔ ماهانه پر شده است. |
| 503 | اکنون هیچ ارائه‌دهنده‌ای برای این مدل در دسترس نیست. تلاش دوباره بی‌خطر است. |