آموزش راه‌اندازی و استفاده

1. دریافت کلید API

   در ربات تلگرام، پکیج خود را فعال کرده و کلید API را کپی کنید.

2. تعریف متغیر محیطی

   پاورشل را باز کنید و دستور زیر را اجرا کنید تا کلید برای حساب کاربری شما ذخیره شود.

   PowerShell کپی

   setx PROMPTPASS_API_KEY "pp-xxxxxxxxxxxxxxxx"
   setx PROMPTPASS_BASE_URL "https://api.promptpass.cloud/v1"

3. بستن و باز کردن مجدد ترمینال

   برای اعمال تغییرات، پنجره ترمینال را ببندید و دوباره باز کنید.

4. بررسی صحت تنظیمات

   با دستور زیر مطمئن شوید مقدار کلید ذخیره شده است.

   PowerShell کپی

   echo $env:PROMPTPASS_API_KEY

این بخش به‌مرور با تصاویر و جزئیات بیشتر تکمیل خواهد شد.

1. باز کردن ترمینال

   برنامه Terminal را از مسیر Applications › Utilities اجرا کنید.

2. افزودن کلید به فایل پیکربندی شل

   دستورات زیر را اجرا کنید تا کلید به‌صورت دائمی ذخیره شود.

   Terminal کپی

   echo 'export PROMPTPASS_API_KEY="pp-xxxxxxxxxxxxxxxx"' >> ~/.zshrc
   echo 'export PROMPTPASS_BASE_URL="https://api.promptpass.cloud/v1"' >> ~/.zshrc
   source ~/.zshrc

3. بررسی صحت تنظیمات

   مقدار ذخیره‌شده را با دستور زیر ببینید.

   Terminal کپی

   echo $PROMPTPASS_API_KEY

اگر از شل دیگری مانند bash استفاده می‌کنید، به‌جای ~/.zshrc فایل ~/.bash_profile را ویرایش کنید.

1. ساخت فایل محیطی پروژه

   در ریشه پروژه یک فایل .env بسازید و مقادیر زیر را در آن قرار دهید.

   .env کپی

   PROMPTPASS_API_KEY=pp-xxxxxxxxxxxxxxxx
   PROMPTPASS_BASE_URL=https://api.promptpass.cloud/v1

2. افزودن فایل به gitignore

   برای جلوگیری از انتشار ناخواسته کلید، نام فایل را به .gitignore اضافه کنید.

3. استفاده در کد

   کلید را از متغیرهای محیطی بخوانید و هرگز آن را مستقیماً در کد ننویسید.

   JavaScript کپی

   const apiKey = process.env.PROMPTPASS_API_KEY;
   const baseUrl = process.env.PROMPTPASS_BASE_URL;

4. افزونه‌های سازگار

   در افزونه‌هایی که امکان تعریف Base URL و API Key دارند، همین دو مقدار را وارد کنید.

این بخش با نمونه‌های بیشتری برای زبان‌های مختلف تکمیل خواهد شد.

1. باز کردن تنظیمات

   در Cursor وارد بخش Settings شوید و به تنظیمات مربوط به مدل‌ها بروید.

2. وارد کردن Base URL

   در فیلد آدرس سرویس، مقدار زیر را قرار دهید.

   Base URL کپی

   https://api.promptpass.cloud/v1

3. وارد کردن کلید API

   کلید دریافتی از ربات را در فیلد API Key وارد و ذخیره کنید.

4. انتخاب مدل و آزمایش

   نام مدل مورد نظر را انتخاب کنید و با یک پیام کوتاه، صحت اتصال را بررسی کنید.

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

1. نصب ابزار

   ابزار خط فرمان را طبق مستندات رسمی خودش روی سیستم نصب کنید.

2. تعریف متغیرهای محیطی

   پیش از اجرا، آدرس سرویس و کلید خود را تعریف کنید.

   Terminal کپی

   export PROMPTPASS_API_KEY="pp-xxxxxxxxxxxxxxxx"
   export PROMPTPASS_BASE_URL="https://api.promptpass.cloud/v1"

3. اجرای ابزار در پوشه پروژه

   وارد پوشه پروژه شوید و ابزار را اجرا کنید تا اتصال برقرار شود.

4. بررسی مصرف

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

جزئیات تنظیمات و نمونه‌های بیشتر در به‌روزرسانی‌های بعدی اضافه می‌شود.

احراز هویت

کلید API را در هدر Authorization و به شکل Bearer ارسال کنید.

Authorization: Bearer pp-xxxxxxxxxxxxxxxx
Content-Type: application/json

نمونه درخواست با cURL

curl https://api.promptpass.cloud/v1/chat/completions \
  -H "Authorization: Bearer $PROMPTPASS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-5",
    "messages": [
      {"role": "user", "content": "یک جمله کوتاه بنویس."}
    ]
  }'

نمونه درخواست با Python

import os
import requests

API_KEY = os.environ["PROMPTPASS_API_KEY"]
BASE_URL = os.environ.get("PROMPTPASS_BASE_URL", "https://api.promptpass.cloud/v1")

response = requests.post(
    f"{BASE_URL}/chat/completions",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json",
    },
    json={
        "model": "claude-sonnet-5",
        "messages": [{"role": "user", "content": "سلام!"}],
    },
    timeout=60,
)

print(response.json())

نکات مهم

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

مستندات کامل‌تر شامل پارامترها و کدهای خطا در همین صفحه اضافه خواهد شد.