メインコンテンツまでスキップ
バージョン: 1.5.0

Guardian API

テキスト

POST v1/guardians/text

リクエスト

ヘッダー

accept string

リクエストボディ

text string required
最大500文字までを受け付けています。

score_threshold integer optional
0.1-1までの値を受け付けています。
default値は0.5です。

model string optional
指定可能なモデル

  • gpt-4o-mini (default)
  • claude-3-haiku
  • gemini-1.5-flash

リクエスト例

cURL
  curl -X POST \
--location 'https://api.pe-ace.net/v1/guardians/text' \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer <API_KEY>" \
-d '{
"text": "<TEXT>"
}'

レスポンス

レスポンス例

status: 200

  {
"flagged": true,
"categories": {
"sexual": false,
"hate": false,
"self_harm": true,
"violence": false,
"defamation": true
},
"category_scores": {
"sexual": 0,
"hate": 0,
"self_harm": 0.9,
"violence": 0,
"defamation": 0.8
}
}

レスポンスステータスコード

Status CodeDescription
200Success
400Validation
401Unauthorized
404Not Found
429Usage Limit Exceeded
500Internal Server Error
501Not Implemented Error

エラーの詳細はよくあるエラーを参照してください。

画像

POST v1/guardians/image

リクエスト

ヘッダー

accept string

リクエストボディ

image string required
Base64エンコードされた画像データを送信します。画像フォーマットとしては、JPEG、PNGなどをサポートしています。

score_threshold integer optional
0.1-1までの値を受け付けています。
default値は0.5です。

リクエスト例

cURL
  curl -X POST \
--location 'https://api.pe-ace.net/v1/guardians/text' \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer <API_KEY>" \
-d '{
"image": "<BASE64_IMAGE>"
}'

レスポンス

レスポンス例

status: 200

  {
"flagged": true,
"categories": {
"sexual": false,
"hate": false,
"self_harm": true,
"violence": false,
"defamation": true
},
"category_scores": {
"sexual": 0,
"hate": 0,
"self_harm": 0.9,
"violence": 0,
"defamation": 0.8
}
}

レスポンスステータスコード

Status CodeDescription
200Success
400Validation
401Unauthorized
404Not Found
429Usage Limit Exceeded
500Internal Server Error
501Not Implemented Error

エラーの詳細はよくあるエラーを参照してください。