メインコンテンツへスキップ

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 キーにより、Refrain API へのプログラマティックアクセスが可能になります。CI/CD、スクリプト、SDK から実行をトリガーするために使用します。

​
API キーの作成

1

API キー設定に移動

設定 > API キーに移動。Admin ロール以上が必要。
2

作成をクリック

API キーを作成ボタンをクリック。
3

キーに名前を付ける

説明的な名前を付けます（例: 「CI/CD パイプライン」「ステージングテスト」）。
4

キーをコピー

完全なキーは1回のみ表示されます。安全に保存してください。
Community プランでは API キーを作成できません。Pro 以上にアップグレードしてください。

​
API キーの使用

​
SDK

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

​
CLI

npx @refrainai/cli execute -- \
  --runbook ./flow.yaml \
  --api-key "rfn-eyJ..."
環境変数でも設定可能： 
export REFRAIN_API_KEY="rfn-eyJ..."

​
API キーの管理

アクション説明
表示キー名、作成日、最終使用日、ステータスを確認
失効キーを永久に無効化（ソフトデリート — 元に戻せない）
失効したキーには revoked バッジが表示され、認証できなくなります。

​
セキュリティ

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