رفتن به محتوا
تغییرات

تغییرات

آخرین به‌روزرسانی‌ها و بهبودهای Shannon API.

این صفحه تغییراتی را فهرست می‌کند که شما به‌عنوان فراخوانی‌کننده API می‌توانید مشاهده کنید: endpointها، فیلدها و مدل‌های جدید، رفتار تغییریافته و رفع اشکال‌ها. جدیدترین ورودی‌ها اول می‌آیند. هر ورودی تاریخ اعمال تغییر را دارد.

ورودی‌ای که با ناسازگار علامت‌گذاری شده می‌تواند نتیجه درخواستی را که قبلاً کار می‌کرد تغییر دهد. API یک نسخه دارد، /v1، پس تغییرات بر اساس تاریخ فهرست می‌شوند، نه شماره نسخه.

  • جدید

    درخواستی با web_search: true منابع خود را نام می‌برد: sources در /v1/chat/completions و /v1/messages نتایجی را که به مدل داده شده فهرست می‌کند و در /v1/chat/completions فیلد annotations مشخص می‌کند پاسخ هر کدام را کجا ارجاع داده است. جستجوی وب داخلی

  • جدید

    web_search: true روی /v1/chat/completions و /v1/messages پیش از پاسخ مدل یک جستجوی وب انجام می‌دهد و نتایج را به‌صورت منابع شماره‌دار به مدل می‌دهد. درخواستی که نتیجه پیدا کند یک جستجو از سهمیه روزانه شما مصرف می‌کند. اگر چیزی باقی نمانده باشد، درخواست بدون جستجو پاسخ داده می‌شود. جستجوی وب داخلی

  • رفع‌شده

    streamی که از سمت سرور قطع شود، برای usageای که تا آن لحظه گزارش شده محاسبه می‌شود. باقی مبلغ رزروشده به موجودی شما برمی‌گردد.

  • رفع‌شده

    shannon-coder-1 روی /v1/responses همان‌طور که روی دو endpoint دیگر پاسخ می‌دهد، پاسخ می‌دهد. ابزارهای CLI برای کدنویسی

  • رفع‌شده

    کلید API تعویض‌شده بلافاصله از کار می‌افتد.

  • جدید

    POST /v1/tokenize و POST /v1/messages/count_tokens: شمارش رایگان توکن برای مدل‌های open-weight میزبانی‌شده. شمارش توکن

  • جدید

    کش کردن پرامپت روی مدل‌های open-weight میزبانی‌شده. ورودی کش‌شده با 25% قیمت ورودی محاسبه می‌شود و در usage روی هر سه endpoint گزارش می‌شود: prompt_tokens_details.cached_tokens، input_tokens_details.cached_tokens و cache_read_input_tokens. GET /v1/models برای این مدل‌ها pricing.cached_input_per_million_usd و capabilities.prompt_caching را گزارش می‌کند. کش کردن پرامپت

  • رفع‌شده

    مدل‌های open-weight میزبانی‌شده: tool_choice اجباری (required یا یک تابع نام‌برده) به فراخوانی ابزار می‌انجامد. فراخوانی توابع

  • رفع‌شده

    مدل‌های open-weight میزبانی‌شده پیام system را که اولین پیام گفتگو نیست می‌پذیرند.

  • جدید

    API به‌صورت سرویس onion در Tor و در یک آدرس I2P در دسترس است. پاسخ‌های api.shannon-ai.com هر دو آدرس را در هدرهای Onion-Location و X-I2P-Location دارند. endpointهای رمزگذاری‌شده، Tor و I2P

  • جدید

    مدل‌های جدید shannon-3.1 و shannon-3.1-pro، که در GET /v1/models فهرست می‌شوند. مدل‌ها و قیمت‌ها

  • تغییر

    درخواست streamشده‌ای که کلاینتش قطع شود تا پایان اجرا می‌شود و شمرده می‌شود. پیش از این، پاسخ با قطع ارتباط متوقف می‌شد.

  • رفع‌شده

    درخواست‌ها به /v1/responses در گزارش مصرف ظاهر می‌شوند.

  • جدید

    مدل‌های open-weight میزبانی‌شده فیلدهای نمونه‌برداری را اعمال می‌کنند: temperature، top_p، seed، stop و max_tokens روی /v1/chat/completions؛ temperature، top_p و stop_sequences روی /v1/messages؛ temperature، top_p و max_output_tokens روی /v1/responses. Chat Completions

  • جدید

    گزارش مصرف برای هر فراخوانی و برای مجموع، هزینه را به USD نشان می‌دهد.

  • ناسازگار

    مقدار model که شناسه منتشرشده نباشد روی هر سه endpoint با 400، نوع invalid_request_error و پیام unknown model: <id> پاسخ داده می‌شود. پیش از این، چنین درخواستی را shannon-1.6-lite پاسخ می‌داد. مدل‌ها و قیمت‌ها

  • ناسازگار

    /v1 فقط کلید API می‌پذیرد. کوکی ورود به وب‌سایت در آنجا خوانده نمی‌شود. احراز هویت

  • تغییر

    محافظت در برابر هجوم درخواست (flood protection): 120 درخواست در دقیقه برای هر حساب روی سه endpoint تولید. محدودیت‌ها و موجودی

  • بهبودیافته

    وقتی مدل نتواند پاسخ دهد، خطا پیام ثابت The model backend failed to answer. Please retry. را دارد. بررسی موجودی‌ای که انجام نشود با 503 و نوع api_error پاسخ داده می‌شود. مدیریت خطا

  • رفع‌شده

    درخواست غیر streamشده‌ای که با شکست مواجه شود، مبلغ رزروشده را به موجودی شما برمی‌گرداند.

  • جدید

    GET /v1/models برای هر مدل capabilities.reasoning_effort را گزارش می‌کند. میزان تلاش استدلال

  • بهبودیافته

    مدل‌های open-weight میزبانی‌شده: درخواست غیر streamشده‌ای که پاسخی نگیرد با 504 و نوع api_error پایان می‌یابد. نتیجه خالی 502 است. مدیریت خطا

  • ناسازگار

    مدل‌های open-weight میزبانی‌شده همان ورودی را می‌پذیرند که مدل نام‌برده می‌پذیرد. تصویری که به شناسه فقط‌متنی فرستاده شود با 400 و <id> does not accept image input پاسخ داده می‌شود. response_format روی شناسه‌ای بدون خروجی ساختاریافته با 400 پاسخ داده می‌شود. GET /v1/models برای هر شناسه capabilities.vision، response_format و json_schema را گزارش می‌کند. تصاویر و فایل‌ها

  • رفع‌شده

    پاسخ‌های غیر streamشده متن استدلال را همراه دارند: reasoning_content روی پیام /v1/chat/completions و یک بلوک thinking پیش از متن روی /v1/messages. میزان تلاش استدلال

  • تغییر

    مدل‌های open-weight میزبانی‌شده قیمت‌های جدید دارند، از $0.50 به ازای هر 1M توکن ورودی و $2.00 به ازای هر 1M توکن خروجی. مدل‌ها و قیمت‌ها

  • تغییر

    مدل‌های open-weight میزبانی‌شده برای هر مدل یک شناسه دارند، در مجموع دوازده شناسه. مدل‌ها و قیمت‌ها

  • جدید

    خروجی ساختاریافته روی shannon-3، shannon-3-pro، shannon-3.1 و shannon-3.1-pro. GET /v1/models برای آن‌ها capabilities.json_schema: true را گزارش می‌کند. خروجی‌های ساختاریافته

  • جدید

    /v1/responses برای خروجی ساختاریافته text.format (json_object یا json_schema) را می‌خواند. Responses API

  • رفع‌شده

    /v1/responses استدلال مدل‌های Shannon را برمی‌گرداند: یک آیتم خروجی reasoning پیش از آیتم message و رویدادهای stream به نام response.reasoning_summary_text.delta و response.reasoning_summary_text.done. Responses API

  • رفع‌شده

    فیلد model در پاسخ روی هر endpoint شناسه منتشرشده است. شیء Responses شامل model و created_at است.

  • بهبودیافته

    GET /v1/models پنجره زمینه هر مدل را گزارش می‌کند. مدل‌ها و قیمت‌ها

  • جدید

    مدل‌های open-weight میزبانی‌شده علاوه بر /v1/chat/completions روی /v1/messages و /v1/responses هم، با system prompt و فراخوانی ابزار شما، پاسخ می‌دهند. /v1/messages فیلد thinking را می‌پذیرد و reasoning_effort یک فیلد درخواست است. مدل‌ها و قیمت‌ها

  • بهبودیافته

    بدنه خطاها روی /v1 از شکل‌های SDK پیروی می‌کند: شیء error با type و message روی endpointهای با فرمت OpenAI، و همان شیء داخل {"type": "error"} روی /v1/messages. مدیریت خطا

  • جدید

    Keep-alive روی streamهای باز هر 15 ثانیه: یک خط توضیح : ping روی /v1/chat/completions و یک event: ping روی /v1/messages. استریم

  • تغییر

    شناسه‌های فراخوانی ابزار روی /v1/chat/completions و /v1/responses با call_ و روی /v1/messages با toolu_ شروع می‌شوند. فراخوانی توابع

  • ناسازگار

    /v1/responses: مقدار پیش‌فرض stream برابر false است. Responses API

  • جدید

    max_completion_tokens به‌عنوان نام دیگری برای max_tokens روی /v1/chat/completions پذیرفته می‌شود. Chat Completions

  • رفع‌شده

    رویداد response.completed در stream مربوط به Responses آرایه output را همراه دارد. Responses API

  • جدید

    ورودی‌های GET /v1/models شامل display_name، context_window، max_output_tokens، pricing، capabilities و endpoints هستند. مدل‌ها و قیمت‌ها

  • جدید

    هر پاسخ x-request-id را همراه دارد و مقداری که بفرستید بازگردانده می‌شود. بدنه درخواست‌ها می‌تواند تا 32 MiB باشد.

  • جدید

    کلید را می‌توان بدون صدور کلید جدید ابطال کرد. گزارش مصرف صفحه‌بندی شده است.

  • جدید

    تصاویر و اسناد در درخواست‌ها: بخش‌های image_url روی /v1/chat/completions، بلوک‌های image، document و file روی /v1/messages، بخش‌های input_image روی /v1/responses. تصاویر و فایل‌ها

  • جدید

    مدل جدید shannon-3-pro. مدل‌ها و قیمت‌ها

  • تغییر

    max_tokens در بازه 1 تا 65,536 نگه داشته می‌شود. مقداری خارج از این بازه به نزدیک‌ترین مرز برده می‌شود و رد نمی‌شود. Chat Completions

  • جدید

    shannon-coder-1 روی /v1/chat/completions و /v1/messages بر حسب تعداد فراخوانی در هر پلن شمرده می‌شود. وقتی فراخوانی‌های یک بازه تمام شود، پاسخ 429 با پیام Shannon Coder call quota reached است. ابزارهای CLI برای کدنویسی

  • جدید

    گفتگویی که از پنجره زمینه بزرگ‌تر باشد با 400، نوع invalid_request_error و کد context_length_exceeded پاسخ داده می‌شود. خطا داخل یک stream به‌صورت رویداد خطا می‌رسد، نه متنی در پاسخ. ابزارهای CLI برای کدنویسی

  • جدید

    endpointهای /v1: POST /v1/chat/completions، POST /v1/messages، POST /v1/responses و GET /v1/models. این‌ها endpointهایی هستند که SDKهای OpenAI و Anthropic، Claude Code و Codex CLI فراخوانی می‌کنند. نمای کلی

  • جدید

    فراخوانی ابزار با tools روی /v1/chat/completions و /v1/messages، خروجی ساختاریافته با response_format و system به‌صورت رشته یا بلوک‌های متنی روی /v1/messages. فراخوانی توابع

  • جدید

    شناسه‌های مدل shannon-1.6-pro، shannon-2-lite، shannon-2-pro و shannon-coder-1، در کنار shannon-1.6-lite. مدل‌ها و قیمت‌ها

  • جدید

    اولین انتشار API: چت با فرمت OpenAI و فرمت Anthropic و یک endpoint برای Responses، که هرکدام با کلید API‌ای که با sk- شروع می‌شود فراخوانی می‌شوند. احراز هویت