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

راهنمای استفاده از جارویس

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

نمای کلی و شروع سریع

جارویس یک درگاه API است: با یک کلید، از ابزارهای کدنویسی و از کد خودتان به مدل‌های کاتالوگ دسترسی دارید. درگاه دو قالب را می‌پذیرد — API سازگار با OpenAI و API پیام‌های Anthropic — پس بیشتر ابزارها فقط با تنظیم آدرس پایه و کلید وصل می‌شوند.

مراحل

در کنسول ثبت‌نام کنید و پلن تهیه کنید. مدل‌هایی که می‌توانید استفاده کنید به پلن فعال شما بستگی دارد.
در صفحهٔ کلیدهای API کلید بسازید. کلید با pmai_ شروع می‌شود و فقط یک‌بار کامل نمایش داده می‌شود.
ابزار خود را از فهرست زیر انتخاب کنید و راهنمایش را دنبال کنید، یا با نمونهٔ درخواست اولین فراخوانی را بفرستید.

کدام راهنما؟

Claude Codeابزار خط فرمان Anthropic، با API پیام‌ها
Claude Code در VS Codeافزونهٔ رسمی Claude Code
Claude Desktopاپ دسکتاپ Claude با درگاه شخص ثالث
Codex CLIدستیار کدنویسی OpenAI، با Responses API
Codex در VS Codeافزونهٔ Codex با همان پیکربندی CLI
Cursorکلید و آدرس سفارشی OpenAI
Clineارائه‌دهندهٔ OpenAI Compatible
Roo Codeارائه‌دهندهٔ OpenAI Compatible
Continueconfig.yaml با ارائه‌دهندهٔ openai
مدل‌های Geminiاز مسیر سازگار با OpenAI
OpenAI SDKکتابخانه‌های رسمی Node.js و Python

ابزارها و SDKهای سازگار با OpenAI

https://api.jarvis.you/v1

Codex، Cursor، Cline، Roo Code، Continue، OpenAI SDK

Claude Code و Claude Desktop (API پیام‌های Anthropic)

https://api.jarvis.you

بدون /v1 — خود ابزار آن را اضافه می‌کند

آدرس درگاه و احراز هویت

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

ابزارها و SDKهای سازگار با OpenAI

https://api.jarvis.you/v1

Codex، Cursor، Cline، Roo Code، Continue، OpenAI SDK

Claude Code و Claude Desktop (API پیام‌های Anthropic)

https://api.jarvis.you

بدون /v1 — خود ابزار آن را اضافه می‌کند

کلید API

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

هدر احراز هویت

کلید را در یکی از این دو هدر بفرستید؛ درگاه هر دو را می‌پذیرد: Authorization: Bearer pmai_… یا x-api-key: pmai_…

متغیرهای محیطی برای SDKها و ابزارهای سازگار با OpenAI

SDKهای رسمی OpenAI این دو متغیر را به‌طور پیش‌فرض می‌خوانند. Claude Code متغیرهای خودش را دارد (راهنمای Claude Code) و Codex آدرس را از فایل پیکربندی می‌خواند (راهنمای Codex).

Windows (PowerShell)

$env:OPENAI_BASE_URL="https://api.jarvis.you/v1"
$env:OPENAI_API_KEY="pmai_xxxxxxxxxxxxxxxxxxxx"

ساخت کلید API در کنسول

انتخاب و فهرست مدل‌ها

هر مدل در کاتالوگ یک Model ID دارد، مثل GPT_5_6_SOL. همین مقدار را در فیلد model درخواست‌ها و تنظیمات ابزارها وارد کنید. Model ID و بقیهٔ مشخصات هر مدل را در کاتالوگ مدل‌ها ببینید.

پشتیبانی‌شده

Model ID همان مقداری است که درگاه اول با آن مدل را پیدا می‌کند؛ بزرگی و کوچکی حروف در آن مهم نیست.
نام مستعار Claude (مثل claude-…) برای ابزارهایی است که فقط شناسه‌های هم‌شکل Claude را می‌پذیرند. به همان مدل می‌رسد و مصرف روی همان مدل ثبت می‌شود؛ مدل دیگری نیست.

محدودیت‌ها و نکته‌ها

همهٔ مدل‌ها در همهٔ پلن‌ها نیستند. هر پلن فهرست مدل‌های مجاز خودش را دارد و درخواست برای مدلی بیرون از آن با خطای ۴۰۳ رد می‌شود.
در پاسخ GET /v1/models، مدلی که نام مستعار دارد دو بار می‌آید — یک بار با Model ID و یک بار با نام مستعار. هر دو یک مدل‌اند؛ این تکرار برای سازگاری با ابزارهاست.

بررسی اتصال

فهرست مدل‌هایی که کلید شما مجاز به استفاده از آن‌هاست (رایگان؛ درخواست مدل اجرا نمی‌شود):

cURL · فهرست مدل‌ها

curl https://api.jarvis.you/v1/models -H "Authorization: Bearer pmai_xxxxxxxxxxxxxxxxxxxx"

Claude Code

Claude Code مستقیماً با API پیام‌های Anthropic (POST /v1/messages) کار می‌کند و درگاه جارویس همین API را ارائه می‌دهد. کافی است آدرس پایه، کلید و مدل‌ها را تنظیم کنید.

پشتیبانی‌شده

کدنویسی و گفت‌وگو در ترمینال با مدل‌های Anthropic کاتالوگ
شمارش توکن پیش از ارسال (/v1/messages/count_tokens) — بدون کسر اعتبار

محدودیت‌ها و نکته‌ها

احراز هویت فقط با کلید جارویس است؛ ورود با حساب Claude لازم نیست و از طریق درگاه استفاده نمی‌شود.
کار با مدل‌های غیر Anthropic از طریق نام مستعار Claude به مسیر بالادستی آن مدل بستگی دارد و تضمین نمی‌شود. برای این مدل‌ها ابزارهای سازگار با OpenAI (Codex، Cline…) مطمئن‌ترند.

پیش‌نیازها

Claude Code نصب‌شده (طبق مستندات Anthropic)
یک کلید pmai_ و پلنی که مدل‌های انتخابی شما را شامل شود

مراحل

ANTHROPIC_BASE_URL را روی https://api.jarvis.you بگذارید — بدون /v1؛ Claude Code خودش /v1/messages را اضافه می‌کند.
ANTHROPIC_AUTH_TOKEN (به‌صورت Authorization: Bearer فرستاده می‌شود) و ANTHROPIC_API_KEY (به‌صورت x-api-key) را برابر همان کلید بگذارید. درگاه هر دو را می‌پذیرد؛ تنظیم هر دو، روش پیشنهادی جارویس است. اگر ANTHROPIC_API_KEY تنظیم باشد، Claude Code در حالت تعاملی یک‌بار تأیید کلید را می‌پرسد.
مدل‌ها را به Model IDهای کاتالوگ پین کنید: ANTHROPIC_MODEL برای مدل اصلی و ANTHROPIC_DEFAULT_HAIKU_MODEL برای کارهای پس‌زمینه (ANTHROPIC_SMALL_FAST_MODEL نام قدیمی همین متغیر است و برای نسخه‌های قدیمی‌تر در نمونه آمده). مدلی که پین نشود با نام پیش‌فرض خود Claude Code فرستاده می‌شود و درگاه آن را نمی‌شناسد.
Claude Code را اجرا کنید. برای تنظیم دائمی به‌جای متغیرهای جلسه، همین مقادیر را در بلوک env فایل settings.json بگذارید (نمونهٔ کامل).

نمونه با مدل‌های CLAUDE_OPUS_4_8 و CLAUDE_HAIKU_4_5؛ Model IDهای دلخواه خود را از کاتالوگ جایگزین کنید.

Windows (PowerShell)

$env:ANTHROPIC_BASE_URL="https://api.jarvis.you"
$env:ANTHROPIC_API_KEY="pmai_xxxxxxxxxxxxxxxxxxxx"
$env:ANTHROPIC_AUTH_TOKEN="pmai_xxxxxxxxxxxxxxxxxxxx"
$env:ANTHROPIC_MODEL="CLAUDE_OPUS_4_8"
$env:ANTHROPIC_DEFAULT_HAIKU_MODEL="CLAUDE_HAIKU_4_5"
$env:ANTHROPIC_SMALL_FAST_MODEL="CLAUDE_HAIKU_4_5"

بررسی اتصال

بدون مصرف توکن: این درخواست کلید و مجاز بودن مدل را مثل یک درخواست واقعی بررسی می‌کند، ولی مدل را اجرا نمی‌کند. پاسخی مثل {"input_tokens": 9} یعنی اتصال درست است.

cURL · بررسی اتصال بدون مصرف توکن

curl https://api.jarvis.you/v1/messages/count_tokens \
  -H "Authorization: Bearer pmai_xxxxxxxxxxxxxxxxxxxx" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{"model": "CLAUDE_HAIKU_4_5", "messages": [{"role": "user", "content": "سلام"}]}'

خطاهای رایج

۴۰۱: کلید اشتباه یا باطل است، یا متغیر احراز هویت تنظیم نشده.
۴۰۳: مدل در پلن شما نیست یا یکی از دو مدل پین نشده است؛ Claude Code برای کارهای پس‌زمینه هم درخواست می‌فرستد.
۴۰۴ یا خطای مسیر: آدرس پایه شامل /v1 است؛ باید دقیقاً https://api.jarvis.you باشد.
۴۰۲: اعتبار توکن اشتراک یا سقف مصرف کلید تمام شده است.

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):Claude Code · LLM gateway(در پنجرهٔ جدید)Claude Code · env vars(در پنجرهٔ جدید)

Claude Code در VS Code

افزونهٔ رسمی Claude Code تنظیمات Claude Code را می‌خواند؛ ساده‌ترین روش دائمی، بلوک env در فایل settings.json است. متغیرها و دلیل هرکدام همان‌هایی است که در راهنمای Claude Code آمده.

پیش‌نیازها

افزونهٔ Claude Code ساخت Anthropic از بخش Extensions (Ctrl+Shift+X)
یک کلید pmai_

مراحل

بلوک زیر را در settings.json Claude Code قرار دهید و کلید خود را جایگزین مقدار نمونه کنید.
مسیر فایل برای هر سیستم‌عامل در تب‌های زیر آمده است.
روش جایگزین طبق مستندات Anthropic: همین متغیرها را در تنظیم VS Code با نام claudeCode.environmentVariables وارد کنید؛ افزونه پیش از اجرا آن را می‌خواند.
VS Code را دوباره باز کنید تا تنظیمات جدید خوانده شود.

~/.claude/settings.json

{
  "env": {
    "ANTHROPIC_BASE_URL": "https://api.jarvis.you",
    "ANTHROPIC_API_KEY": "pmai_xxxxxxxxxxxxxxxxxxxx",
    "ANTHROPIC_AUTH_TOKEN": "pmai_xxxxxxxxxxxxxxxxxxxx",
    "ANTHROPIC_MODEL": "CLAUDE_OPUS_4_8",
    "ANTHROPIC_DEFAULT_HAIKU_MODEL": "CLAUDE_HAIKU_4_5",
    "ANTHROPIC_SMALL_FAST_MODEL": "CLAUDE_HAIKU_4_5"
  }
}

Windows

%USERPROFILE%\.claude\settings.json

بررسی اتصال

در پنل Claude Code یک پیام کوتاه بفرستید. اگر پاسخ آمد، اتصال برقرار است.

خطاهای رایج

۴۰۳: یکی از مدل‌ها پین نشده یا در پلن شما نیست.
۴۰۱: کلید اشتباه است یا متغیرهای احراز هویت خوانده نشده‌اند (VS Code را دوباره باز کنید).
خطای مسیر: مقدار ANTHROPIC_BASE_URL نباید /v1 داشته باشد (https://api.jarvis.you).

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):Claude Code · settings(در پنجرهٔ جدید)Claude Code · LLM gateway(در پنجرهٔ جدید)

Claude Desktop

اپ دسکتاپ Claude می‌تواند به‌جای سرویس Anthropic از یک درگاه شخص ثالث استفاده کند. برای مدل‌های غیر Claude، نام مستعار Claude همان مدل را انتخاب کنید؛ مصرف روی همان مدل اصلی ثبت می‌شود.

پشتیبانی‌شده

گفت‌وگو با مدل‌های Anthropic کاتالوگ با شناسهٔ خودشان
مدل‌های غیر Claude از راه نام مستعار Claude

محدودیت‌ها و نکته‌ها

طبق مستندات Anthropic، وقتی درگاه فعال است فقط محیط محلی در دسترس است و Remote Control کار نمی‌کند.
به تجربهٔ تیم جارویس، اپ فقط شناسه‌های هم‌شکل Claude را در انتخاب مدل می‌پذیرد؛ این رفتار در مستندات Anthropic ذکر نشده، برای همین مدل‌های غیر Claude نام مستعار دارند.

پیش‌نیازها

آخرین نسخهٔ Claude Desktop
یک کلید pmai_

مراحل

از منوی Help → Troubleshooting گزینهٔ Enable Developer Mode را فعال کنید.
از منوی Developer گزینهٔ Configure Third-Party Inference را باز کنید. اگر سازمان شما پیکربندی را مدیریت کند، این فرم فقط‌خواندنی است.
آدرس درگاه را https://api.jarvis.you — بدون /v1 — و کلید را کلید جارویس خود وارد کنید.
مدل را انتخاب کنید: مدل‌های Anthropic با Model ID خودشان و بقیه با نام مستعار Claude (جدول زیر).

Claude Desktop · Third-Party Inference

Gateway base URL: https://api.jarvis.you
API key: pmai_xxxxxxxxxxxxxxxxxxxx

نام‌های مستعار Claude نمونه

کاتالوگ زنده در دسترس نبود؛ این جدول نمونه است. فهرست معتبر را در کاتالوگ مدل‌ها ببینید.

GPT-5.6 Solclaude-5.6-sol
GPT-5.5claude-5.5
GPT-5.4claude-5.4
Gemini 2.5 Proclaude-2.5-pro
DeepSeek R1claude-deepseek-r1

بررسی اتصال

یک گفت‌وگوی تازه باز کنید و پیام کوتاهی بفرستید. برای بررسی بدون مصرف توکن از نمونهٔ «بررسی اتصال» در راهنمای Claude Code استفاده کنید.

خطاهای رایج

۴۰۱: کلید اشتباه یا باطل است.
۴۰۳: نام مدل در کاتالوگ نیست یا مدل در پلن شما مجاز نیست.
مدل در فهرست اپ نیست: برای مدل غیر Claude، نام مستعار Claude آن را وارد کنید، نه Model ID.

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):Claude Code · LLM gateway(در پنجرهٔ جدید)

Codex CLI

Codex از Responses API استفاده می‌کند و درگاه جارویس /v1/responses را ارائه می‌دهد. درگاه را به‌عنوان یک ارائه‌دهندهٔ سفارشی در ~/.codex/config.toml تعریف کنید.

پشتیبانی‌شده

کدنویسی و گفت‌وگو با Model IDهای کاتالوگ از طریق Responses API

محدودیت‌ها و نکته‌ها

Codex فقط wire_api = "responses" را می‌پذیرد؛ مقدار قدیمی "chat" در نسخه‌های فعلی خطا می‌دهد.
Codex دیگر OPENAI_BASE_URL را نمی‌خواند؛ آدرس درگاه باید در base_url فایل پیکربندی باشد.
شناسهٔ openai برای ارائه‌دهنده رزرو شده است؛ از شناسهٔ دیگری مثل jarvis استفاده کنید.
پشتیبانی Responses API برای هر مدل به مسیر بالادستی همان مدل بستگی دارد.

پیش‌نیازها

Codex CLI نصب‌شده
یک کلید pmai_

مراحل

فایل ~/.codex/config.toml را با بلوک زیر بسازید یا کامل کنید؛ model را Model ID دلخواه از کاتالوگ بگذارید.
متغیر محیطی OPENAI_API_KEY را برابر کلید خود قرار دهید — env_key در پیکربندی به همین متغیر اشاره می‌کند.
Codex را اجرا کنید.

~/.codex/config.toml

model = "GPT_5_6_SOL"
model_provider = "jarvis"

[model_providers.jarvis]
name = "Jarvis"
base_url = "https://api.jarvis.you/v1"
env_key = "OPENAI_API_KEY"
wire_api = "responses"

Windows (PowerShell)

$env:OPENAI_API_KEY="pmai_xxxxxxxxxxxxxxxxxxxx"

بررسی اتصال

در Codex یک درخواست کوتاه بفرستید. پاسخ عادی یعنی اتصال برقرار است.

خطاهای رایج

۴۰۱: کلید اشتباه، باطل‌شده یا ارسال‌نشده است. کلید باید با pmai_ شروع شود.
۴۰۳: مدل در پلن فعال این کلید مجاز نیست، اشتراک فعالی ندارید، یا نام مدل در کاتالوگ نیست. فهرست مدل‌های مجاز کلید را با GET https://api.jarvis.you/v1/models ببینید.
۴۰۲: اعتبار توکن اشتراک یا سقف مصرف همین کلید تمام شده است؛ وضعیت را در کنسول ببینید.
۴۰۴ یا خطای مسیر: آدرس پایه باید دقیقاً https://api.jarvis.you/v1 باشد — با /v1 و بدون اسلش اضافه در انتها.
wire_api: اگر خطای «wire_api = "chat" is no longer supported» گرفتید، مقدار را "responses" کنید.

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):Codex · config reference(در پنجرهٔ جدید)

Codex در VS Code

افزونهٔ Codex همان ~/.codex/config.toml مربوط به Codex CLI را می‌خواند؛ یک پیکربندی برای هر دو کافی است.

پیش‌نیازها

افزونهٔ Codex ساخت OpenAI از بخش Extensions
یک کلید pmai_

مراحل

فایل ~/.codex/config.toml را با بلوک زیر بسازید — بین CLI و افزونه مشترک است.
متغیر OPENAI_API_KEY را برابر کلید خود قرار دهید؛ اگر افزونه ورود با کلید API را پیشنهاد داد، همان کلید را وارد کنید.
VS Code را دوباره باز کنید.

~/.codex/config.toml

model = "GPT_5_6_SOL"
model_provider = "jarvis"

[model_providers.jarvis]
name = "Jarvis"
base_url = "https://api.jarvis.you/v1"
env_key = "OPENAI_API_KEY"
wire_api = "responses"

بررسی اتصال

در پنل Codex یک درخواست کوتاه بفرستید.

خطاهای رایج

۴۰۱: کلید اشتباه، باطل‌شده یا ارسال‌نشده است. کلید باید با pmai_ شروع شود.
۴۰۳: مدل در پلن فعال این کلید مجاز نیست، اشتراک فعالی ندارید، یا نام مدل در کاتالوگ نیست. فهرست مدل‌های مجاز کلید را با GET https://api.jarvis.you/v1/models ببینید.
۴۰۲: اعتبار توکن اشتراک یا سقف مصرف همین کلید تمام شده است؛ وضعیت را در کنسول ببینید.
۴۰۴ یا خطای مسیر: آدرس پایه باید دقیقاً https://api.jarvis.you/v1 باشد — با /v1 و بدون اسلش اضافه در انتها.

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):Codex · config reference(در پنجرهٔ جدید)

Cursor

Cursor اجازه می‌دهد کلید و آدرس سفارشی OpenAI را برای مدل‌های گفت‌وگو استفاده کنید.

پشتیبانی‌شده

گفت‌وگو با مدل‌های کاتالوگ که به‌صورت دستی به Cursor اضافه می‌کنید

محدودیت‌ها و نکته‌ها

طبق مستندات Cursor، کلیدهای سفارشی فقط برای مدل‌های گفت‌وگو کار می‌کنند؛ تکمیل خودکار (Tab) همچنان از مدل‌های خود Cursor استفاده می‌کند.
درخواست‌ها از سرورهای Cursor عبور می‌کنند، پس آدرس درگاه باید از اینترنت در دسترس باشد (آدرس عمومی جارویس هست).
گزینهٔ بازنویسی آدرس پایه در مستندات رسمی Cursor شرح داده نشده و فقط در انجمن Cursor آمده است؛ این اتصال را «بهترین تلاش» بدانید. به گفتهٔ همان منبع، این تنظیم روی همهٔ مدل‌ها اثر می‌گذارد و برخی مدل‌های اختصاصی Cursor با کلید سفارشی کار نمی‌کنند.

پیش‌نیازها

Cursor نصب‌شده
یک کلید pmai_

مراحل

در Cursor Settings → Models کلید OpenAI را کلید جارویس خود بگذارید و گزینهٔ Override OpenAI Base URL را روی https://api.jarvis.you/v1 تنظیم کنید.
Model ID دلخواه (مثلاً GPT_5_6_SOL) را به‌عنوان مدل سفارشی اضافه و انتخاب کنید.

بررسی اتصال

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

خطاهای رایج

۴۰۱: کلید اشتباه، باطل‌شده یا ارسال‌نشده است. کلید باید با pmai_ شروع شود.
۴۰۳: مدل در پلن فعال این کلید مجاز نیست، اشتراک فعالی ندارید، یا نام مدل در کاتالوگ نیست. فهرست مدل‌های مجاز کلید را با GET https://api.jarvis.you/v1/models ببینید.
۴۰۲: اعتبار توکن اشتراک یا سقف مصرف همین کلید تمام شده است؛ وضعیت را در کنسول ببینید.
۴۰۴ یا خطای مسیر: آدرس پایه باید دقیقاً https://api.jarvis.you/v1 باشد — با /v1 و بدون اسلش اضافه در انتها.

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):Cursor · API keys(در پنجرهٔ جدید)

Cline

Cline با ارائه‌دهندهٔ «OpenAI Compatible» به درگاه وصل می‌شود.

پیش‌نیازها

افزونهٔ Cline در VS Code
یک کلید pmai_

مراحل

در تنظیمات Cline، API Provider را OpenAI Compatible انتخاب کنید.
Base URL را https://api.jarvis.you/v1، API Key را کلید خود و Model ID را Model ID مدل از کاتالوگ بگذارید.
در صورت نیاز، بخش Model Configuration (پنجرهٔ متن، پشتیبانی تصویر) را مطابق مدل تنظیم کنید.

OpenAI Compatible

API Provider: OpenAI Compatible
Base URL: https://api.jarvis.you/v1
API Key: pmai_xxxxxxxxxxxxxxxxxxxx
Model ID: GPT_5_6_SOL

بررسی اتصال

در Cline یک کار کوچک بخواهید؛ پاسخ عادی یعنی اتصال برقرار است.

خطاهای رایج

۴۰۱: کلید اشتباه، باطل‌شده یا ارسال‌نشده است. کلید باید با pmai_ شروع شود.
۴۰۳: مدل در پلن فعال این کلید مجاز نیست، اشتراک فعالی ندارید، یا نام مدل در کاتالوگ نیست. فهرست مدل‌های مجاز کلید را با GET https://api.jarvis.you/v1/models ببینید.
۴۰۲: اعتبار توکن اشتراک یا سقف مصرف همین کلید تمام شده است؛ وضعیت را در کنسول ببینید.
۴۰۴ یا خطای مسیر: آدرس پایه باید دقیقاً https://api.jarvis.you/v1 باشد — با /v1 و بدون اسلش اضافه در انتها.

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):Cline · OpenAI Compatible(در پنجرهٔ جدید)

Roo Code

Roo Code هم ارائه‌دهندهٔ «OpenAI Compatible» را با همان سه مقدار می‌پذیرد.

محدودیت‌ها و نکته‌ها

مخزن رسمی Roo Code از اردیبهشت ۱۴۰۵ بایگانی شده و آخرین نسخه‌اش v3.54.0 است؛ به‌روزرسانی تازه‌ای از سازنده انتظار نمی‌رود.
طبق مستندات Roo Code، فقط مدل‌هایی که فراخوانی ابزار بومی دارند با آن کار می‌کنند.

پیش‌نیازها

افزونهٔ Roo Code در VS Code
یک کلید pmai_

مراحل

ارائه‌دهنده را OpenAI Compatible انتخاب کنید.
Base URL را https://api.jarvis.you/v1، کلید را کلید خود و Model را Model ID مدل بگذارید.

OpenAI Compatible

API Provider: OpenAI Compatible
Base URL: https://api.jarvis.you/v1
API Key: pmai_xxxxxxxxxxxxxxxxxxxx
Model ID: GPT_5_6_SOL

بررسی اتصال

یک درخواست کوتاه بفرستید.

خطاهای رایج

۴۰۱: کلید اشتباه، باطل‌شده یا ارسال‌نشده است. کلید باید با pmai_ شروع شود.
۴۰۳: مدل در پلن فعال این کلید مجاز نیست، اشتراک فعالی ندارید، یا نام مدل در کاتالوگ نیست. فهرست مدل‌های مجاز کلید را با GET https://api.jarvis.you/v1/models ببینید.
۴۰۲: اعتبار توکن اشتراک یا سقف مصرف همین کلید تمام شده است؛ وضعیت را در کنسول ببینید.
۴۰۴ یا خطای مسیر: آدرس پایه باید دقیقاً https://api.jarvis.you/v1 باشد — با /v1 و بدون اسلش اضافه در انتها.

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):Roo Code · OpenAI Compatible(در پنجرهٔ جدید)

Continue

Continue مدل‌ها را در ~/.continue/config.yaml تعریف می‌کند (فایل config.json قدیمی منسوخ شده است). درگاه را با ارائه‌دهندهٔ openai و apiBase معرفی کنید.

محدودیت‌ها و نکته‌ها

Continue برای برخی نام‌های مدل ممکن است به‌جای Chat Completions از /responses استفاده کند؛ درگاه هر دو را ارائه می‌دهد. اگر خطا دیدید، useResponsesApi: false را به مدل اضافه کنید تا Chat Completions استفاده شود.

پیش‌نیازها

افزونهٔ Continue در VS Code یا JetBrains
یک کلید pmai_

مراحل

بلوک زیر را در ~/.continue/config.yaml قرار دهید و کلید خود را جایگزین مقدار نمونه کنید.
برای هر مدل دیگر یک مورد جدید در فهرست models با Model ID همان مدل اضافه کنید.

~/.continue/config.yaml

name: Jarvis
version: 0.0.1
schema: v1
models:
  - name: GPT_5_6_SOL
    provider: openai
    model: GPT_5_6_SOL
    apiBase: https://api.jarvis.you/v1
    apiKey: pmai_xxxxxxxxxxxxxxxxxxxx

بررسی اتصال

مدل «GPT_5_6_SOL» را در Continue انتخاب و پیام کوتاهی بفرستید.

خطاهای رایج

۴۰۱: کلید اشتباه، باطل‌شده یا ارسال‌نشده است. کلید باید با pmai_ شروع شود.
۴۰۳: مدل در پلن فعال این کلید مجاز نیست، اشتراک فعالی ندارید، یا نام مدل در کاتالوگ نیست. فهرست مدل‌های مجاز کلید را با GET https://api.jarvis.you/v1/models ببینید.
۴۰۲: اعتبار توکن اشتراک یا سقف مصرف همین کلید تمام شده است؛ وضعیت را در کنسول ببینید.
۴۰۴ یا خطای مسیر: آدرس پایه باید دقیقاً https://api.jarvis.you/v1 باشد — با /v1 و بدون اسلش اضافه در انتها.

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):Continue · OpenAI provider(در پنجرهٔ جدید)

مدل‌های Gemini

مدل‌های Gemini کاتالوگ از مسیر سازگار با OpenAI در دسترس‌اند: هر ابزار یا SDK سازگار با OpenAI را به درگاه وصل کنید و Model ID یک مدل Gemini (مثلاً GEMINI_3_1_PRO) را انتخاب کنید.

محدودیت‌ها و نکته‌ها

ابزار خط فرمان رسمی Gemini (Gemini CLI) قالب بومی Google را می‌فرستد و نمی‌تواند به درگاه سازگار با OpenAI وصل شود؛ GOOGLE_GEMINI_BASE_URL فقط میزبان را عوض می‌کند، نه قالب را.

مراحل

یکی از ابزارهای سازگار با OpenAI را طبق راهنمایش تنظیم کنید (OpenAI SDK، Cline، Continue…).
نام مدل را Model ID یک مدل Gemini از کاتالوگ بگذارید.

Windows (PowerShell)

$env:OPENAI_BASE_URL="https://api.jarvis.you/v1"
$env:OPENAI_API_KEY="pmai_xxxxxxxxxxxxxxxxxxxx"

بررسی اتصال

فهرست مدل‌های مجاز کلید را بگیرید و مطمئن شوید مدل Gemini مورد نظر در آن هست (فهرست مدل‌ها).

خطاهای رایج

۴۰۱: کلید اشتباه، باطل‌شده یا ارسال‌نشده است. کلید باید با pmai_ شروع شود.
۴۰۳: مدل در پلن فعال این کلید مجاز نیست، اشتراک فعالی ندارید، یا نام مدل در کاتالوگ نیست. فهرست مدل‌های مجاز کلید را با GET https://api.jarvis.you/v1/models ببینید.
۴۰۲: اعتبار توکن اشتراک یا سقف مصرف همین کلید تمام شده است؛ وضعیت را در کنسول ببینید.
۴۰۴ یا خطای مسیر: آدرس پایه باید دقیقاً https://api.jarvis.you/v1 باشد — با /v1 و بدون اسلش اضافه در انتها.

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):Gemini CLI · configuration(در پنجرهٔ جدید)

OpenAI SDK

SDKهای رسمی OpenAI برای Node.js و Python فقط با تغییر آدرس پایه و کلید به درگاه وصل می‌شوند.

پشتیبانی‌شده

Chat Completions (client.chat.completions.create)
Responses API (client.responses.create) — پشتیبانی هر مدل به مسیر بالادستی آن بستگی دارد
تولید و ویرایش تصویر با مدل‌های تصویری (نقاط پایانی)

پیش‌نیازها

بستهٔ openai برای Node.js یا Python
یک کلید pmai_

مراحل

در ساخت کلاینت، baseURL (Node.js) یا base_url (Python) را https://api.jarvis.you/v1 بگذارید؛ هر دو SDK در نبود این مقدار، متغیر OPENAI_BASE_URL را می‌خوانند.
کلید را در apiKey / api_key یا متغیر OPENAI_API_KEY قرار دهید.
نام مدل را Model ID کاتالوگ بگذارید.

cURL

curl https://api.jarvis.you/v1/chat/completions \
  -H "Authorization: Bearer pmai_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "GPT_5_6_SOL",
    "messages": [{ "role": "user", "content": "سلام!" }]
  }'

بررسی اتصال

نمونهٔ زیر را اجرا کنید؛ این درخواست مقدار کمی توکن مصرف می‌کند.

خطاهای رایج

۴۰۱: کلید اشتباه، باطل‌شده یا ارسال‌نشده است. کلید باید با pmai_ شروع شود.
۴۰۳: مدل در پلن فعال این کلید مجاز نیست، اشتراک فعالی ندارید، یا نام مدل در کاتالوگ نیست. فهرست مدل‌های مجاز کلید را با GET https://api.jarvis.you/v1/models ببینید.
۴۰۲: اعتبار توکن اشتراک یا سقف مصرف همین کلید تمام شده است؛ وضعیت را در کنسول ببینید.
۴۰۴ یا خطای مسیر: آدرس پایه باید دقیقاً https://api.jarvis.you/v1 باشد — با /v1 و بدون اسلش اضافه در انتها.

مستندات رسمی (بررسی‌شده در ۱ مهر ۱۴۰۵):openai-node(در پنجرهٔ جدید)openai-python(در پنجرهٔ جدید)

نقاط پایانی درگاه

همهٔ مسیرها زیر https://api.jarvis.you/v1 هستند و با کلید جارویس (Authorization: Bearer یا x-api-key) احراز هویت می‌شوند. سازگاری قالب به معنای کار کردن همهٔ قابلیت‌های هر ابزار نیست؛ هر ابزار را با راهنمای خودش بسنجید.

روش و مسیر	قالب	کاربرد
POST`/v1/chat/completions`	OpenAI	تکمیل گفت‌وگو
POST`/v1/responses`	OpenAI	Responses API (برای Codex و SDKها)
POST`/v1/completions`	OpenAI	تکمیل متن (سازگاری قدیمی)
POST`/v1/messages`	Anthropic	پیام‌ها (برای Claude Code و Claude Desktop)
POST`/v1/messages/count_tokens`	Anthropic	شمارش توکن؛ مدل اجرا و مصرفی ثبت نمی‌شود
GET`/v1/models`	OpenAI	مدل‌های مجاز کلید شما
POST`/v1/images/generations`	OpenAI	تولید تصویر (JSON)
POST`/v1/images/edits`	OpenAI	ویرایش تصویر (multipart یا data URI)

تصویر

مسیرهای تصویر فقط با مدل‌های تصویری کاتالوگ کار می‌کنند و هر درخواست یک تصویر می‌سازد (n فقط ۱). هزینه برای هر درخواست موفق ثابت است و در پروفایل همان مدل در کاتالوگ آمده؛ درخواست ناموفق هزینه‌ای ندارد. ویرایش، فایل‌ها را به‌صورت multipart/form-data یا data URI در JSON می‌پذیرد و ماسک پشتیبانی نمی‌شود. حداکثر حجم درخواست ۳۲ مگابایت است.

cURL · تولید تصویر

curl https://api.jarvis.you/v1/images/generations \
  -H "Authorization: Bearer pmai_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"model": "GPT_IMAGE_2_5_FLARE", "prompt": "a lighthouse at dusk", "size": "1024x1024"}'

نمونهٔ درخواست

اولین درخواست با cURL، Node.js یا Python. کلید نمونه ساختگی است؛ کلید خود را از کنسول جایگزین کنید. مدل نمونه GPT_5_6_SOL است؛ Model ID دلخواه را از کاتالوگ بردارید.

متغیرهای محیطی

Windows (PowerShell)

$env:OPENAI_BASE_URL="https://api.jarvis.you/v1"
$env:OPENAI_API_KEY="pmai_xxxxxxxxxxxxxxxxxxxx"

درخواست

cURL

curl https://api.jarvis.you/v1/chat/completions \
  -H "Authorization: Bearer pmai_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "GPT_5_6_SOL",
    "messages": [{ "role": "user", "content": "سلام!" }]
  }'

فهرست مدل‌های مجاز کلید

cURL · فهرست مدل‌ها

curl https://api.jarvis.you/v1/models -H "Authorization: Bearer pmai_xxxxxxxxxxxxxxxxxxxx"

بررسی اتصال

پاسخ موفق شامل choices[0].message.content است. این درخواست مقدار کمی توکن مصرف می‌کند.

خطاهای رایج

۴۰۱: کلید اشتباه، باطل‌شده یا ارسال‌نشده است. کلید باید با pmai_ شروع شود.
۴۰۳: مدل در پلن فعال این کلید مجاز نیست، اشتراک فعالی ندارید، یا نام مدل در کاتالوگ نیست. فهرست مدل‌های مجاز کلید را با GET https://api.jarvis.you/v1/models ببینید.
۴۰۲: اعتبار توکن اشتراک یا سقف مصرف همین کلید تمام شده است؛ وضعیت را در کنسول ببینید.
۴۰۴ یا خطای مسیر: آدرس پایه باید دقیقاً https://api.jarvis.you/v1 باشد — با /v1 و بدون اسلش اضافه در انتها.

راهنمای استفاده از جارویس

مراحل

کدام راهنما؟

کلید API

هدر احراز هویت

متغیرهای محیطی برای SDKها و ابزارهای سازگار با OpenAI

پشتیبانی‌شده

محدودیت‌ها و نکته‌ها

بررسی اتصال

پشتیبانی‌شده

محدودیت‌ها و نکته‌ها

پیش‌نیازها

مراحل

بررسی اتصال

خطاهای رایج

پیش‌نیازها

مراحل

بررسی اتصال

خطاهای رایج

پشتیبانی‌شده

محدودیت‌ها و نکته‌ها

پیش‌نیازها

مراحل

نام‌های مستعار Claude نمونه

بررسی اتصال

خطاهای رایج

پشتیبانی‌شده

محدودیت‌ها و نکته‌ها

پیش‌نیازها

مراحل

بررسی اتصال

خطاهای رایج

پیش‌نیازها

مراحل

بررسی اتصال

خطاهای رایج

پشتیبانی‌شده

محدودیت‌ها و نکته‌ها

پیش‌نیازها

مراحل

بررسی اتصال

خطاهای رایج

پیش‌نیازها

مراحل

بررسی اتصال

خطاهای رایج

محدودیت‌ها و نکته‌ها

پیش‌نیازها

مراحل

بررسی اتصال

خطاهای رایج

محدودیت‌ها و نکته‌ها

پیش‌نیازها

مراحل

بررسی اتصال

خطاهای رایج

محدودیت‌ها و نکته‌ها

مراحل

بررسی اتصال

خطاهای رایج

پشتیبانی‌شده

پیش‌نیازها

مراحل

بررسی اتصال

خطاهای رایج

تصویر

متغیرهای محیطی

درخواست

فهرست مدل‌های مجاز کلید

بررسی اتصال

خطاهای رایج

مراحل

هنوز حل نشد؟

خطاهای رایج