توثيق API
دليل اندماج مفصل ومرجع API لمساعدتك على دمج خدمة TokenWorks AI API بسرعة
1بدء سريع
استخدام TokenWorks API يتطلب ثلاث خطوات بسيطة فقط:
- سجل حسابًا في TokenWorks وقم بتسجيل الدخول إلى لوحة التحكم
- أنشئ API Key في لوحة التحكم
- استخدم API Key الخاص بك لاستدعاء واجهاتنا
Tip: سيحصل المستخدمون الجدد على رصيد تجريبي مجاني بعد التسجيل، ويمكنهم البدء دون ربط بطاقة ائتمان.
2عنوان الواجهة
العنوان الأساسي لـ API كما يلي، جميع الطلبات تستخدم بروتوكول HTTPS:
https://www.token8341.com/v1واجهة إكمال الدردشة:
POST https://www.token8341.com/v1/chat/completionsNote: هذه الواجهة متوافقة تمامًا مع تنسيق واجهة Chat Completions من OpenAI، يمكنك استخدام SDK الخاص بـ OpenAI مباشرة للاستدعاء.
3طريقة المصادقة
يستخدم TokenWorks مصادقة Bearer Token للتحقق من API. يرجى تضمين API Key الخاص بك في ترويسة الطلب:
Authorization: Bearer sk-your-api-key-hereيمكنك إنشاء وإدارة مفاتيحك في صفحة «API Keys» بلوحة التحكم. يرجى الاحتفاظ بـ API Key الخاص بك بأمان، وعدم كشفه في مستودعات الأكواد العامة أو أكواد العميل.
4قائمة النماذج المدعومة
| معرف النموذج | اسم النموذج | المزود |
|---|---|---|
| gpt-4o | GPT-4o | OpenAI |
| gpt-4o-mini | GPT-4o Mini | OpenAI |
| claude-3-5-sonnet | Claude 3.5 Sonnet | Anthropic |
| claude-4-sonnet | Claude 4 Sonnet | Anthropic |
| gemini-2-0-pro | Gemini 2.0 Pro | |
| deepseek-v4-pro | DeepSeek-V4-Pro | DeepSeek |
| qwen-max | Qwen-Max | Alibaba Cloud |
يتم إضافة المزيد من النماذج باستمرار، يرجى متابعة إعلانات التحديث الخاصة بنا.
5أمثلة الأكواد
curl
curl https://www.token8341.com/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-your-api-key-here" \
-d '{
"model": "gpt-4o",
"messages": [
{"role": "user", "content": "Hello!"}
]
}'Python (openai SDK)
from openai import OpenAI
client = OpenAI(
base_url="https://www.token8341.com/v1",
api_key="sk-your-api-key-here"
)
response = client.chat.completions.create(
model="gpt-4o",
messages=[
{"role": "user", "content": "Hello!"}
]
)
print(response.choices[0].message.content)Node.js (openai SDK)
import OpenAI from "openai";
const client = new OpenAI({
baseURL: "https://www.token8341.com/v1",
apiKey: "sk-your-api-key-here",
});
const response = await client.chat.completions.create({
model: "gpt-4o",
messages: [
{ role: "user", content: "Hello!" },
],
});
console.log(response.choices[0].message.content);6شرح رموز الأخطاء
عند فشل طلب API، يتم إرجاع رمز حالة HTTP المقابل ورسالة الخطأ بالتنسيق التالي:
{
"error": {
"message": "Insufficient balance",
"type": "insufficient_balance",
"code": 402
}
}| رمز الحالة | الاسم | الوصف |
|---|---|---|
| 400 | Bad Request | 请求参数错误,请检查请求体格式 |
| 401 | Unauthorized | API Key 无效或缺失,请检查 Authorization 请求头 |
| 402 | Insufficient Balance | 账户余额不足,请充值后重试 |
| 404 | Not Found | 请求的模型或接口不存在 |
| 429 | Rate Limit | 请求频率过高,请稍后重试 |
| 500 | Internal Server Error | 服务内部错误,请联系技术支持 |
| 503 | Service Unavailable | 模型服务暂时不可用,请稍后重试 |