مستندات API کنسول CDSAI
دسترسی برنامهنویسی به مدلهای پلتفرم — سازگار با OpenAI
۱. دریافت کلید API
وارد حساب شوید، از منوی بالای صفحه به بخش «کلید API» بروید و روی «ساخت کلید جدید» بزنید. کلید فقط یک بار نمایش داده میشود — آن را کپی و امن نگه دارید. هر کلید شکل زیر را دارد:
sk-cdsai-xxxxxxxxxxxxxxxxxxxxxxxxxxxx۲. آدرس پایه
همه درخواستها با احراز هویت Authorization: Bearer به این آدرس ارسال میشوند و کاملاً با قالب OpenAI سازگارند:
https://console.cdsai.app/api/v1۳. مثال cURL
curl https://console.cdsai.app/api/v1/chat/completions \
-H "Authorization: Bearer sk-cdsai-..." \
-H "Content-Type: application/json" \
-d '{
"model": "openai/gpt-4o-mini",
"messages": [{"role": "user", "content": "سلام!"}]
}'curl https://console.cdsai.app/api/v1/chat/completions \
-H "Authorization: Bearer sk-cdsai-..." \
-H "Content-Type: application/json" \
-d '{
"model": "openai/gpt-4o-mini",
"messages": [{"role": "user", "content": "یک شعر کوتاه بگو"}],
"stream": true
}'۴. پایتون (کتابخانه OpenAI)
from openai import OpenAI
client = OpenAI(
base_url="https://console.cdsai.app/api/v1",
api_key="sk-cdsai-...",
)
response = client.chat.completions.create(
model="openai/gpt-4o-mini",
messages=[{"role": "user", "content": "سلام!"}],
)
print(response.choices[0].message.content)۵. Node.js / TypeScript
import OpenAI from "openai";
const client = new OpenAI({
baseURL: "https://console.cdsai.app/api/v1",
apiKey: "sk-cdsai-...",
});
const stream = await client.chat.completions.create({
model: "openai/gpt-4o-mini",
messages: [{ role: "user", content: "سلام!" }],
stream: true,
});
for await (const chunk of stream) {
process.stdout.write(chunk.choices[0]?.delta?.content ?? "");
}۶. ابزارهای کدنویسی
در ابزارهایی مثل Cursor، Cline، Continue یا Windsurf یک «OpenAI-compatible / Custom provider» بسازید:
- Base URL:
https://console.cdsai.app/api/v1 - API Key: کلید
sk-cdsai-…شما - Model: شناسه مدل از بخش بعدی (مثلاً
anthropic/claude-sonnet-4)
۷. فهرست مدلها
curl https://console.cdsai.app/api/v1/models \
-H "Authorization: Bearer sk-cdsai-..."شناسهای که در فیلد model میفرستید باید دقیقاً یکی از شناسههای همین فهرست باشد (مثلاً openai/gpt-4o-mini). اگر بین سرویسدهندهها نام تکراری بود، شکلسرویسدهنده:مدل را استفاده کنید.
۸. هزینه و محدودیتها
هزینه هر درخواست دقیقاً مثل گفتگو در پنل، بر اساس توکنهای واقعی مصرفی و تعرفه همان مدل از کیف پول حساب شما کسر میشود.
- حداکثر ۶۰ درخواست در دقیقه برای هر کلید
- حداکثر ۱۰ کلید فعال برای هر حساب
- اگر موجودی کیف پول تمام شود، درخواستها با خطای ۴۰۲ رد میشوند
- تصاویر فقط با مدلهای «تصویری» قابل ارسال است (data URI یا URL عمومی)
۹. خطاها
{
"error": {
"message": "کلید API نامعتبر است",
"type": "invalid_request_error",
"code": "invalid_api_key"
}
}| کد | معنا |
|---|---|
| 401 | کلید نامعتبر یا باطلشده |
| 400 | بدنه درخواست یا نام مدل نامعتبر است |
| 402 | موجودی کیف پول کافی نیست |
| 404 | مدل یافت نشد |
| 429 | محدودیت نرخ (۶۰ درخواست در دقیقه) |
| 502 | خطا از سمت سرویسدهنده upstream |
آماده شروع هستید؟ اولین کلید خود را بسازید.
ساخت کلید API