API ドキュメント

クイックスタート

APIキーを発行したら、あとは 1 リクエストです。お使いの言語を選んでください。

1. 1.

   APIキーを発行する

   ダッシュボードの「APIキー」から発行します。キーは発行したときに一度だけ表示されます。

2. 2.

   Authorization ヘッダに載せる

   次の形式で送ります。伏せ字の部分が発行したキーに置き換わります。

   Authorization: Bearer mc_live_xxxxx
3. 3.

   判定を呼び出す

   判定したい文字列を text に入れて POST します。応答は次のとおりです。

curl -X POST https://api.moji-care.com/v1/moderations \
  -H "Authorization: Bearer $MOJICARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"これはうんこです"}'

{
  "id": "mod_9f8a7b6c5d4e",
  "flagged": true,
  "masked": "これは***です",
  "matches": [
    "うんこ"
  ],
  "usage": {
    "chars": 8
  }
}

サンプルの MOJICARE_API_KEY はサーバー側の環境変数です。キーそのものをコードに書かないでください。

APIリファレンス

リクエスト・レスポンス・エラーコードの一覧です。コード生成に使う定義ファイルはこちら: OpenAPI 3.1（JSON）