مستندات API
راهنمای اتصال دقیق و مرجع API، برای ادغام سریع شما با سرویس API هوش مصنوعی TokenWorks
1شروع سریع
استفاده از API TokenWorks فقط سه مرحله ساده دارد:
- ثبتنام حساب 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 | 模型服务暂时不可用,请稍后重试 |