API ドキュメント
詳細な導入ガイドと API リファレンスで、TokenWorks AI API サービスを迅速に統合できます
1クイックスタート
TokenWorks API の利用はわずか3ステップです:
- TokenWorks アカウントを登録し、コンソールにログインします
- コンソールで API Key を作成します
- API Key を使用して当社のインターフェースを呼び出します
Tip: 新規ユーザーは登録後、無料体験枠が付与され、クレジットカードの登録なしですぐに利用を開始できます。
2インターフェースアドレス
API のベースアドレスは以下の通りです。すべてのリクエストは HTTPS プロトコルを使用します:
text
https://www.token8341.com/v1チャット補完インターフェース:
text
POST https://www.token8341.com/v1/chat/completionsNote: このインターフェースは OpenAI の Chat Completions インターフェース形式と完全に互換性があり、OpenAI の SDK を直接使用して呼び出すことができます。
3認証方式
TokenWorks は Bearer Token を使用して API 認証を行います。リクエストヘッダーに API Key を含めてください:
text
Authorization: Bearer sk-your-api-key-hereコンソールの「API Keys」ページでキーを作成・管理できます。API Key は適切に保管し、公開コードリポジトリやクライアントコードで公開しないでください。
4サポートされているモデルリスト
| モデル ID | モデル名 | プロバイダー |
|---|---|---|
| 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
bash
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)
python
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)
javascript
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 ステータスコードとエラー情報が返されます。形式は以下の通りです:
json
{
"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 | 模型服务暂时不可用,请稍后重试 |