Logo

這裡提供完整的開發指南與最佳實踐,幫助您快速上手。

快速開始

第一個 API 請求

三步驟即可發出第一個請求:登入控制台、建立 API 金鑰、在 Header 帶入金鑰並呼叫翻譯端點。

本章以「文字翻譯」端點為例,帶您完成第一個請求。後續章節會深入認證、錯誤處理、字庫與串流。

三步驟開始

  1. 登入控制台並完成帳號設定。
  2. 在「API 金鑰」頁面建立一把新金鑰。金鑰僅顯示一次,請立即複製並妥善保存。
  3. 在 HTTP Header 帶入 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 串流」。