Skip to main content

​
概要

npx @refrainai/cli serve
Web コンソールとリモート手順書実行を支える HTTP API サーバーを起動します。REST エンドポイント、SSE ストリーミング、Inngest によるジョブスケジューリング、Redis Pub/Sub によるリアルタイム更新を提供します。
API サーバーのリモート実行機能には Team プラン以上が必要です。

​
前提条件

サーバー起動前に以下を準備してください：
  1. PostgreSQL — 手順書、ジョブ、設定、メータリング用データベース
  2. Redis — SSE リアルタイムストリーミングと Pub/Sub に必要
  3. Inngest（任意） — スケジュール・バックグラウンド実行用ジョブキュー

​
環境変数

​
必須

変数説明
DATABASE_URLPostgreSQL 接続文字列
REDIS_URLRedis 接続文字列
BETTER_AUTH_SECRET認証用シークレット（セッション署名）

​
オプション

変数デフォルト説明
PORT3000サーバーポート
INNGEST_EVENT_KEY-Inngest イベントキー
INNGEST_SIGNING_KEY-Inngest 署名キー
REFRAIN_API_KEY-デフォルト API キー

​
AI プロバイダー認証情報

サーバーは CLI と同じ AI プロバイダー環境変数を使用します：
変数説明
ANTHROPIC_API_KEYAnthropic API キー
OPENAI_API_KEYOpenAI API キー
GOOGLE_GENERATIVE_AI_API_KEYGemini API キー
AZURE_RESOURCE_NAMEAzure OpenAI リソース名
AZURE_API_KEYAzure OpenAI API キー
AWS_REGIONBedrock の AWS リージョン
AWS_ACCESS_KEY_IDBedrock の AWS アクセスキー
AWS_SECRET_ACCESS_KEYBedrock の AWS シークレットキー
GOOGLE_VERTEX_PROJECTVertex の Google Cloud プロジェクト
GOOGLE_VERTEX_LOCATIONVertex の Google Cloud リージョン

​
セットアップ

1

環境の設定

必須変数を含む .env ファイルを作成します：
DATABASE_URL="postgresql://user:pass@localhost:5432/refrain"
REDIS_URL="redis://localhost:6379"
BETTER_AUTH_SECRET="your-random-secret"
ANTHROPIC_API_KEY="sk-ant-..."
2

データベースマイグレーション

npx @refrainai/cli db:migrate
3

サーバーの起動

npx @refrainai/cli serve

​
API エンドポイント

サーバーは手順書、ジョブ、設定を管理する REST エンドポイントを提供します。全エンドポイントは API キーまたはセッションによる認証が必要です。
エンドポイントメソッド説明
/api/runbooksGET手順書一覧
/api/runbooksPOST手順書の作成
/api/runbooks/:idGET手順書の詳細
/api/jobsPOSTジョブの作成（execute/generate/self-heal）
/api/jobsGETジョブ一覧
/api/jobs/:idGETジョブの詳細
/api/jobs/:id/streamGETリアルタイム更新の SSE ストリーム
/api/jobs/:id/approvePOST待機中ジョブの承認
/api/jobs/:id/rejectPOST待機中ジョブの拒否
/api/jobs/:id/cancelPOST実行中ジョブのキャンセル
プログラマティックな使用方法は SDK を参照してください。