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

# API キー

> プログラマティックアクセス用 API キーの生成と管理。

## 概要

API キーにより、Refrain API へのプログラマティックアクセスが可能になります。CI/CD、スクリプト、[SDK](/ja/sdk/overview) から実行をトリガーするために使用します。

## API キーの作成

<Steps>
  <Step title="API キー設定に移動">
    **設定 > API キー**に移動。Admin ロール以上が必要。
  </Step>

  <Step title="作成をクリック">
    **API キーを作成**ボタンをクリック。
  </Step>

  <Step title="キーに名前を付ける">
    説明的な名前を付けます（例: 「CI/CD パイプライン」「ステージングテスト」）。
  </Step>

  <Step title="キーをコピー">
    完全なキーは1回のみ表示されます。安全に保存してください。
  </Step>
</Steps>

<Note>
  Community プランでは API キーを作成できません。Pro 以上にアップグレードしてください。
</Note>

## API キーの使用

### SDK

```typescript theme={null}
const client = new Refrain({
  ai: { ... },
  apiKey: "rfn-eyJ...",
});
```

### CLI

```bash theme={null}
npx @refrainai/cli execute -- \
  --runbook ./flow.yaml \
  --api-key "rfn-eyJ..."
```

環境変数でも設定可能：

```bash theme={null}
export REFRAIN_API_KEY="rfn-eyJ..."
```

## API キーの管理

| アクション  | 説明                          |
| ------ | --------------------------- |
| **表示** | キー名、作成日、最終使用日、ステータスを確認      |
| **失効** | キーを永久に無効化（ソフトデリート — 元に戻せない） |

失効したキーには `revoked` バッジが表示され、認証できなくなります。

## セキュリティ

* 完全なキーは作成時に1回のみ表示 — 安全に保管してください
* 失効したキーは再有効化不可
* キーはテナントのプランティアを継承