۱۰۰ هزار تومان هدیهٔ ثبت‌نام، تا ۱ میلیونبا ثبت‌نام گردونهٔ هدیه را بچرخان: دست‌کم ۱۰۰٬۰۰۰ تومان و تا ۱٬۰۰۰٬۰۰۰ تومان اعتبار هدیه، بدون کارت بانکیگردونهٔ هدیه۱ میلیون برای تو، ۱ میلیون برای دوستتدوستانت را دعوت کن: برای هر دوستی که فعال شود ۱٬۰۰۰٬۰۰۰ تومان اعتبار هدیه می‌گیری و خودش هم ۱٬۰۰۰٬۰۰۰ تومانجوایز
1xAi
مستندات API

فراخوانی تابع، خروجی ساختاریافته و ورودی تصویر

دروازه بدنهٔ درخواست را ترجمه نمی‌کند: فیلدهای tools و tool_choice، response_format (از جمله json_schema) و بخش‌های image_url همان‌طور که فرستاده‌ای به سازندهٔ مدل می‌رسند و پاسخ او همان‌طور برمی‌گردد. پس هر مدلی که این قابلیت‌ها را نزد سازندهٔ خودش دارد، این‌جا هم دارد؛ اینکه یک مدل مشخص کدام را می‌پذیرد با سازندهٔ آن است. ابزارهای سمت سرور حساب جدایی دارند: فقط آن‌هایی مجازند که هزینه‌شان قابل اندازه‌گیری است.

آخرین به‌روزرسانی:

فهرست مستندات

فراخوانی تابع و خروجی ساختاریافته · ۱

چه چیزی عبور می‌کند

فیلدهایی که بدون تغییر عبور می‌کنند
قابلیتفیلدهامسیر
فراخوانی تابعtools (type: "function"), tool_choice, parallel_tool_calls/v1/chat/completions, /v1/responses
خروجی ساختاریافتهresponse_format (json_object, json_schema)/v1/chat/completions
ورودی تصویربخش image_url در content (نشانی یا data URL)/v1/chat/completions
ورودی صدابخش input_audio در content/v1/chat/completions
پارامترهای استدلالreasoning_effort, reasoning/v1/chat/completions, /v1/responses
ابزارهای Anthropictools, tool_choice, thinking, cache_control/anthropic/v1/messages
ابزارهای Geminitools.functionDeclarations, generationConfig.responseSchema/gemini/v1beta/models/{model}:generateContent
  • تنها تغییرهایی که دروازه در بدنه می‌دهد در این فهرست است. یکی از آن‌ها به این صفحه مربوط است: برای مدل‌های DeepSeek، json_schema به json_object تبدیل می‌شود (طرح‌واره را در پرامپت هم بنویس).
  • اگر مدلی فیلدی را نپذیرد، خطای خود سازنده با همان وضعیت به تو می‌رسد و هزینه‌ای ندارد.
  • تصویر و فایل درون درخواست در حجم بدنه شمرده می‌شوند.

فراخوانی تابع و خروجی ساختاریافته · ۲

نمونه: فراخوانی تابع

POST /v1/chat/completions
curl
curl https://1xai.ir/v1/chat/completions \
  -H "Authorization: Bearer 1xai-..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5-mini",
    "messages": [{"role": "user", "content": "هوای تهران چطور است؟"}],
    "tools": [{
      "type": "function",
      "function": {
        "name": "get_weather",
        "description": "Current weather for a city",
        "parameters": {
          "type": "object",
          "properties": {"city": {"type": "string"}},
          "required": ["city"]
        }
      }
    }],
    "tool_choice": "auto"
  }'

پاسخ در choices[0].message.tool_calls نام تابع و آرگومان‌ها را دارد. تابع را خودت اجرا کن و نتیجه را با پیامی به نقش tool و همان tool_call_id برگردان.

فراخوانی تابع و خروجی ساختاریافته · ۳

نمونه: خروجی ساختاریافته

POST /v1/chat/completions
curl
curl https://1xai.ir/v1/chat/completions \
  -H "Authorization: Bearer 1xai-..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5-mini",
    "messages": [{"role": "user", "content": "نام و سال انتشار یک کتاب معروف را بده."}],
    "response_format": {
      "type": "json_schema",
      "json_schema": {
        "name": "book",
        "strict": true,
        "schema": {
          "type": "object",
          "properties": {"title": {"type": "string"}, "year": {"type": "integer"}},
          "required": ["title", "year"],
          "additionalProperties": false
        }
      }
    }
  }'

فراخوانی تابع و خروجی ساختاریافته · ۴

نمونه: ورودی تصویر

POST /v1/chat/completions
curl
curl https://1xai.ir/v1/chat/completions \
  -H "Authorization: Bearer 1xai-..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gemini-3.5-flash",
    "messages": [{
      "role": "user",
      "content": [
        {"type": "text", "text": "در این تصویر چه می‌بینی؟"},
        {"type": "image_url", "image_url": {"url": "data:image/jpeg;base64,/9j/4AAQ..."}}
      ]
    }]
  }'

تصویر را به‌صورت data URL (base64) بفرست تا به در دسترس بودن یک نشانی از سمت سازنده وابسته نباشی. کل بدنهٔ درخواست تا ۲۵ مگابایت است.

فراخوانی تابع و خروجی ساختاریافته · ۵

ابزارهای سمت سرور

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

ابزارهای سمت سرور در هر مسیر
مسیرمجازردشده
/v1/chat/completionsابزارهای تابعی (function، custom)؛ فیلد web_search_optionsهر نوع ابزار دیگر
/v1/responsesابزارهای تابعی و web_searchcode_interpreter, file_search, image_generation, computer_use, mcp
/anthropic/v1/messagesابزارهای خودت، و web_search، web_fetch، bash، text_editor، computer و memorycode_execution
/gemini/…:generateContentfunctionDeclarations و grounding با Google Searchgrounding با Google Maps
  • جست‌وجوی وب به‌ازای هر جست‌وجو و با نرخ جست‌وجوی همان مدل حساب می‌شود. پیش از تماس مبلغ چند جست‌وجو (تا ۳ در OpenAI و Anthropic) رزرو و پس از پاسخ به اندازهٔ جست‌وجوهای انجام‌شده کم می‌شود.
  • مدلی که نرخ جست‌وجو ندارد با ابزار جست‌وجو خطای 400 با کد search_not_priced می‌گیرد.
  • ابزار ردشده خطای 400 با کد hosted_tool_unmetered می‌گیرد (در Gemini برای Google Maps خطای 402 با همین کد).
  • ابزارهای bash، text_editor، computer و memory در Anthropic را برنامهٔ خودت اجرا می‌کند؛ هزینه‌شان فقط توکن است.