> ## Documentation Index
> Fetch the complete documentation index at: https://docs.starfort.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Guard API クイックスタート

> 5 分で最初のリクエストをガードします。API キーを作成し、エンドポイントを呼び出して、action を読み取ります。

Guard API を使うと、Starfort のガードレールを自社のアプリケーションに組み込めます。モデルへの**入力**時に呼び出して（プロンプトをマスクまたはブロック）、また出力時に呼び出して（レスポンスをチェック）使用します。

## 1. API キーを取得する

API キーは、**API プロジェクト**内の **Guardian** に属します。Console で対象の Guardian を開き、**API Keys** → **Add API Key** を選択して、キーをコピーしてください（キーは一度だけ表示され、`sf_` で始まります）。[API キーの管理](/ja/v1.2/admin/api-keys)を参照してください。

エンドポイントと、すぐに使えるサンプルは Guardian の **How to use** タブにあります。

## 2. リクエストを送信する

```bash theme={null}
curl -X POST "https://bastion-guardian-api.starfort.io/v1/guard/api" \
  -H "Content-Type: application/json" \
  -H "X-Starfort-Guard-Api-Key: sf_your_key_here" \
  -d '{
    "messages": [
      { "role": "user", "content": "What time does the library open on weekends?" }
    ],
    "processType": "input"
  }'
```

`processType` は **Guardian が宣言する**ラベルです（一般的には、入力時のリクエストには `input`、出力時のモデルレスポンスには `output`）。これは Guardian がサポートするもののいずれかでなければなりません。[リクエスト形式](/ja/v1.2/api/request-format)を参照してください。

## 3. action を読み取る

問題のないリクエストはそのまま通過します。

```json theme={null}
{ "action": "PASS", "input_results": [] }
```

PII を含むものを送信すると、Guardian がそれをマスクします（PII ポリシーが割り当てられている場合）。

```json theme={null}
{
  "action": "MASK",
  "input_results": [{
    "index": 0, "type": "text", "action": "MASK",
    "processed_content": "My number is [PHONE_NUMBER_1].",
    "results": [ /* … */ ]
  }]
}
```

アプリケーションは、トップレベルの **`action`** に基づいて動作させてください。`MASK` の場合は `processed_content` を転送し、`BLOCK` の場合はリクエストを拒否します。Topic ポリシーは **`CHECK`**（レビュー対象としてフラグが立てられた論争のあるトピック）を返すこともあり、API 呼び出し元は `CHECK` を直接受け取ります。[アクション](/ja/v1.2/concepts/actions-pass-mask-block)を参照してください。

Guardian が**分析できない**リクエストは HTTP エラーを返し、空の検出結果を伴う `PASS` を返すことは決してありません。これにより、エラーが「何も検出されなかった」と誤って解釈されることはありません。[エラーと状態](/ja/v1.2/api/errors)を参照してください。

<Steps>
  <Step title="キーを作成する">Console で対象の Guardian → API Keys から作成します。</Step>
  <Step title="エンドポイントを呼び出す">`X-Starfort-Guard-Api-Key` ヘッダーを付けて `POST /v1/guard/api` を呼び出します。</Step>
  <Step title="action を処理する">PASS → 続行 · MASK → `processed_content` を使用 · BLOCK → 停止。</Step>
</Steps>

## 次のステップ

<CardGroup cols={2}>
  <Card title="認証" icon="key" href="/ja/v1.2/api/authentication" />

  <Card title="リクエスト形式" icon="arrow-right-to-bracket" href="/ja/v1.2/api/request-format" />

  <Card title="レスポンス形式" icon="arrow-right-from-bracket" href="/ja/v1.2/api/response-format" />

  <Card title="エラーと状態" icon="triangle-exclamation" href="/ja/v1.2/api/errors" />
</CardGroup>
