Guardian API

POST v1/guardians/text

リクエスト

ヘッダー

accept string

リクエストボディ

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

score_threshold integer optional
0-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 '{
    "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 Code	Description
200	Success
400	Validation
401	Unauthorized
404	Not Found
429	Usage Limit Exceeded
500	Internal Server Error
501	Not Implemented Error

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