مستندات

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

احراز هویت

هر درخواست باید شامل کلید API شما در هدر Authorization با استفاده از طرح Bearer باشد.

Authorization: Bearer YOUR_API_KEY

تولید و مدیریت کلیدها از طریق پنل خود: بخش کلیدهای API

شروع سریع

اولین درخواست خود را با زبان دلخواهتان ارسال کنید. عبارت YOUR_API_KEY را با کلیدی از پنل خود جایگزین کنید.

curl https://apiex.cloud/api/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [
      { "role": "user", "content": "Hello!" }
    ]
  }'

from openai import OpenAI

client = OpenAI(
    base_url="https://apiex.cloud/api/v1/",
    api_key="YOUR_API_KEY",
)

response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Hello!"}],
)

print(response.choices[0].message.content)

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://apiex.cloud/api/v1/",
  apiKey: "YOUR_API_KEY",
});

const response = await client.chat.completions.create({
  model: "gpt-4o-mini",
  messages: [{ role: "user", content: "Hello!" }],
});

console.log(response.choices[0].message.content);

$ch = curl_init( "https://apiex.cloud/api/v1/chat/completions" );

curl_setopt_array( $ch, array(
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => array(
        'Authorization: Bearer YOUR_API_KEY',
        'Content-Type: application/json',
    ),
    CURLOPT_POSTFIELDS => json_encode( array(
        'model'    => 'gpt-4o-mini',
        'messages' => array(
            array( 'role' => 'user', 'content' => 'Hello!' ),
        ),
    ) ),
) );

$response = json_decode( curl_exec( $ch ), true );
echo $response['choices'][0]['message']['content'];

خطاها

این API از کدهای وضعیت استاندارد HTTP استفاده می‌کند. کدهای محدوده 2xx نشان‌دهنده موفقیت؛ کدهای 4xx نشان‌دهنده مشکل در درخواست؛ و کدهای 5xx نشان‌دهنده مشکلی در سمت ما هستند.

پاسخ‌های خطا دارای ساختار JSON سازگاری هستند:

{
  "error": {
    "type": "insufficient_balance",
    "message": "Wallet balance is too low to complete this request.",
    "code": 402
  }
}

آدرس پایه و نقاط پایانی

تمام درخواست‌ها به این آدرس پایه ارسال می‌شوند:

https://apiex.cloud/api/v1/

تکمیل‌های گفتگو

یک پاسخ مدل برای یک مکالمه مشخص ایجاد می‌کند. ساختار درخواست و پاسخ با API تکمیل چت OpenAI مطابقت دارد.

پارامترهای درخواست

نمونه پاسخ

{
  "id": "chatcmpl_8k2f...",
  "object": "chat.completion",
  "model": "gpt-4o-mini",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I help you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 10,
    "total_tokens": 19
  }
}

پاسخ‌های جریانی

برای دریافت پاسخ به صورت تدریجی به عنوان رویدادهای ارسالی از سرور، عبارت "stream": true را تنظیم کنید که برای رابط‌های چت ایده‌آل است.

data: {"choices":[{"delta":{"content":"Hello"}}]}

data: {"choices":[{"delta":{"content":"!"}}]}

data: [DONE]

محدودیت‌های نرخ

محدودیت‌های نرخ از پایداری درگاه برای همه محافظت می‌کند. محدودیت‌ها به طرح فعال شما بستگی دارد و برای هر کلید API اعمال می‌شود.

هر پاسخ شامل هدرهایی است که وضعیت فعلی محدودیت شما را شرح می‌دهند:

کیف پول و صورتحساب

هر حساب دارای یک کیف پول پیش‌پرداخت است. یک بار آن را شارژ کنید، سپس در هر مدل پشتیبانی‌شده‌ای هزینه کنید — مصرف بر اساس توکن‌ها یا واحدهای مصرف‌شده به ازای هر درخواست کسر می‌شود.

کلیدهای API

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

بهترین روش‌ها

• یک کلید جداگانه برای هر اپلیکیشن یا محیط (تولید، استیجینگ، محلی) ایجاد کنید.
• کلیدها را در متغیرهای محیطی ذخیره کنید، هرگز در کنترل نسخه قرار ندهید.
• از گروه‌های کلید برای تعیین سقف هزینه یا محدود کردن یک کلید به مدل‌های خاص استفاده کنید.
• اگر مشکوک هستید که کلیدی افشا شده است، فوراً آن را لغو کنید.

ایجاد کلید API

طرح‌ها و اشتراک‌ها

یک طرح برای اعتبار ماهانه پیش‌بینی‌پذیر انتخاب کنید، یا روی پرداخت به میزان مصرف بمانید و به سادگی کیف پول خود را شارژ کنید.

مدل‌ها و ارائه‌دهندگان

دروازه در حال حاضر به ارائه‌دهندگان زیر متصل می‌شود. برای دریافت لیست دقیق و زنده مدل‌ها، درخواست GET /models را با کلید API خود ارسال کنید.

OpenAI

Anthropic

Google AI

DeepSeek

Zhipu AI

Moonshot AI

Tencent

Meta

پرسش‌های متداول