Logo

包括的な開発者ガイドとベストプラクティスで、すばやく開発を始められます。

提供サービス

API モジュール一覧

クイックスタート

最初の API リクエスト

3 ステップで最初のリクエストを送れます。コンソールへサインイン、API キーを作成、ヘッダーにキーを付けて翻訳エンドポイントを呼び出します。

本章ではテキスト翻訳エンドポイントを例に、最初のリクエストを送るまでを説明します。認証、エラー処理、辞書、ストリーミングは後続の章で取り上げます。

3 ステップで始める

  1. デベロッパーコンソールにサインインし、アカウント設定を完了します。
  2. 「API キー」ページで新しいキーを作成します。キーは一度だけ表示されるため、その場でコピーし安全に保管してください。
  3. HTTP ヘッダーに X-API-Key を付与し、翻訳エンドポイントへ POST リクエストを送信します。

例:テキストを翻訳する

POST /api/v1/translations/text に対し、テキスト、目的言語、ソース言語(省略時は自動検出)を送信します。

リクエスト例

bash
curl -X POST "https://abemono.abestar.com.tw/api/v1/translations/text" \
  -H "X-API-Key: [YOUR_API_KEY]" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello, how are you?",
    "target_language": "zh-TW",
    "source_language": "en-US"
  }'

[YOUR_API_KEY] をご自身の API キーに置き換えてください

成功時のレスポンス

200 が返り、data に翻訳結果と使用モデルコードが入り、usage で課金対象文字数が示されます。

成功レスポンス例(HTTP 200)

json
{
  "translated_text": "你好,你好嗎?",
  "detected_source_lang": "en-US",
  "usage": {
    "quota_percent": {
      "used": 5
    }
  },
  "forced_replacement_count": 0
}

エラー応答

失敗時は error オブジェクトが返ります。code はエラーコード、message は説明文、request_id は本リクエストの識別子です。問題を報告する際は必ず添付してください。

エラー応答例(HTTP 401)

json
{
  "error": {
    "code": "unauthorized",
    "message": "API key is missing or invalid.",
    "details": {},
    "request_id": "0af7651916cd43dd8448eb211c80319c"
  }
}

次のステップ

キーの扱いの詳細は「認証」、エラーコード一覧は「エラー処理」、長文の逐次出力は「SSE ストリーミング」を参照してください。