Error Codes

PII-Fi APIのエラーコードとトラブルシューティングガイドです。

HTTP Status Codes

Code	Status	Description
`200`	OK	リクエストが正常に処理されました
`400`	Bad Request	リクエスト形式が不正です
`401`	Unauthorized	認証エラー（APIキーが無効または未指定）
`404`	Not Found	リソースが見つかりません
`422`	Unprocessable Entity	バリデーションエラー
`429`	Too Many Requests	レート制限に達しました
`500`	Internal Server Error	サーバー内部エラー

Error Response Format

エラーレスポンスは以下のJSON形式で返されます。

{
  "detail": "Error message here"
}

Validation Error (422)

バリデーションエラーの場合、詳細な情報が配列で返されます。

{
  "detail": [
    {
      "type": "literal_error",
      "loc": ["body", "deidentification_type"],
      "msg": "Input should be 'replace', 'mask', 'full_mask', 'hash' or 'fake'",
      "input": "invalid_type"
    }
  ]
}

Field	Description
`type`	エラータイプ
`loc`	エラー発生箇所（配列形式）
`msg`	エラーメッセージ
`input`	入力された値

Common Errors & Solutions

401 Unauthorized

⚠ Authentication Error

原因: APIキーが無効または未指定

解決方法:

APIキーが正しく設定されているか確認
キーは pk_live_ で始まる形式
Authorization: Bearer YOUR_API_KEY 形式で指定

# 正しい形式
curl -H "Authorization: Bearer pk_live_xxxxxxxx" ...

# 間違い: Bearerがない
curl -H "Authorization: pk_live_xxxxxxxx" ...

400 Bad Request

⚠ Request Format Error

原因: Content-Typeが不正、またはJSONパースエラー

解決方法:

Content-Type: application/json ヘッダーを設定
リクエストボディが有効なJSON形式か確認

# 正しい形式
curl -X POST https://api.pii-fi.com/api/detect \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"text": "テスト"}'

422 Unprocessable Entity

⚠ Validation Error

原因: リクエストパラメータが不正

よくある原因:

deidentification_type に無効な値を指定
必須パラメータ text が未指定
enabled_entities に存在しないエンティティタイプを指定

// 有効な deidentification_type の値
"replace"    // タグ形式で置換
"mask"       // 部分マスク
"full_mask"  // 完全マスク
"hash"       // ハッシュ値
"fake"       // ダミーデータ

404 Not Found

💡 Resource Not Found

原因: 指定したリソースが存在しない

よくある原因:

存在しないポリシー名を指定
存在しない認識器IDを指定
存在しない辞書IDを指定

500 Internal Server Error

⚠ Server Error

原因: サーバー内部でエラーが発生

解決方法:

しばらく待ってからリトライ
問題が継続する場合はサポートに連絡

Batch Processing Errors

/detect/batch エンドポイントでは、100件を超えるリクエストを送信すると 400 Bad Request が返されます。

{
  "detail": "Batch size exceeds maximum limit of 100"
}

Troubleshooting Tips

ログ確認: エラーレスポンスの detail フィールドを確認
リクエスト検証: curlやPostmanで手動リクエストを試行
タイムアウト: 大きなテキストの場合、タイムアウト設定を確認
APIキー確認: APIキーが正しく設定されているか確認

Need Help?

問題が解決しない場合は、お問い合わせフォームからご連絡ください。