هوش.یارمستندات

API درگاه

درگاه API اوپن‌ای‌آی و API پیام‌های Anthropic را پشتیبانی می‌کند. این صفحه همهٔ سطح‌هایی را که یک کلاینت می‌تواند فراخوانی کند فهرست می‌کند.

نشانی پایه

https://gateway.example.com

احراز هویت

کلید کلاینت را در سرآیند Authorization: Bearer بفرستید. سطح Anthropic سرآیند x-api-key را هم می‌پذیرد.

مسیرها

بیشتر سطح‌ها از یک مسیر استفاده می‌کنند. صفحهٔ «اتصال کلاینت» روش انتخاب مسیر را توضیح می‌دهد.

سطحی که خاموش است

مدیر سیستم می‌تواند یک سطح را خاموش کند. سطح خاموش با کد 404 و surface_disabled پاسخ می‌دهد.

سطح‌ها

chat

یک درخواست گفتگو با قالب OpenAI بفرستید. درگاه مسیر و مدل را انتخاب می‌کند.

متدمسیر نشانی
POST/v1/chat/completions

messages

یک پیام با قالب API پیام‌های Anthropic بفرستید. Claude Code از این سطح استفاده می‌کند.

متدمسیر نشانی
POST/v1/messages
POST/v1/messages/count_tokens

embeddings

بردار (embedding) بسازید. یک مدل مشخص نام ببرید؛ درگاه این سطح را مسیریابی نمی‌کند.

متدمسیر نشانی
POST/v1/embeddings

moderations

متن را با یک مدل نظارت بررسی کنید. یک مدل نظارت مشخص نام ببرید.

متدمسیر نشانی
POST/v1/moderations

models

مسیرهایی را که کلیدتان می‌تواند استفاده کند، به‌علاوهٔ auto، فهرست کنید. هر مسیر به شکل نام یک مدل نشان داده می‌شود.

متدمسیر نشانی
GET/v1/models

guard

متن را بدون فراخوانی مدل با قواعد محافظ (guardrail) پیکربندی‌شده بررسی کنید.

متدمسیر نشانی
POST/v1/guard

classify

بپرسید یک درخواست به کدام مسیر می‌رود و چرا، بدون فراخوانی مدل.

متدمسیر نشانی
POST/v1/classify

responses

از Responses API اوپن‌ای‌آی استفاده کنید: یک پاسخ را بسازید، بخوانید، لغو کنید و حذف کنید.

متدمسیر نشانی
POST/v1/responses
GET/v1/responses/{id}
DELETE/v1/responses/{id}
POST/v1/responses/{id}/cancel
GET/v1/responses/{id}/input_items

images

تصویر بسازید، ویرایش کنید و تنوع بدهید. ویرایش و تنوع چندبخشی هستند: یک مدل مشخص نام ببرید.

متدمسیر نشانی
POST/v1/images/generations
POST/v1/images/edits
POST/v1/images/variations

audio

از متن گفتار بسازید، یا از صوت رونوشت یا ترجمه. رونویسی چندبخشی است.

متدمسیر نشانی
POST/v1/audio/speech
POST/v1/audio/transcriptions
POST/v1/audio/translations

rerank

فهرستی از سندها را بر اساس ارتباط با یک پرسش مرتب کنید.

متدمسیر نشانی
POST/v1/rerank

files

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

متدمسیر نشانی
POST/v1/files
GET/v1/files
GET/v1/files/{id}
GET/v1/files/{id}/content
DELETE/v1/files/{id}

batches

batch بفرستید، فهرست کنید، بخوانید و لغو کنید. همان کلیدی را به کار ببرید که فایل ورودی را بارگذاری کرده است.

متدمسیر نشانی
POST/v1/batches
GET/v1/batches
GET/v1/batches/{id}
POST/v1/batches/{id}/cancel

mcp

ابزارهای شرکت را به عنوان یک سرور MCP (نسخهٔ 2026-07-28) نصب کنید. کلید کلاینت خود را به کار ببرید.

متدمسیر نشانی
همه/mcp
همه/mcp/{mount}
GET/.well-known/oauth-protected-resource
GET/.well-known/oauth-protected-resource/mcp
GET/.well-known/oauth-protected-resource/mcp/{mount}
GET/oauth/callback

connect

یک ابزار REST تعریف‌شده را با شکل HTTP خودش فراخوانی کنید. درگاه اعتبارنامه را اضافه می‌کند.

متدمسیر نشانی
همه/connect/{server}
همه/connect/{server}/{path}