Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
リモート実行と Web コンソール用の API サーバーを起動します。
npx @refrainai/cli serve
| 変数 | 説明 |
|---|---|
DATABASE_URL | PostgreSQL 接続文字列 |
REDIS_URL | Redis 接続文字列 |
BETTER_AUTH_SECRET | 認証用シークレット（セッション署名） |
| 変数 | デフォルト | 説明 |
|---|---|---|
PORT | 3000 | サーバーポート |
INNGEST_EVENT_KEY | - | Inngest イベントキー |
INNGEST_SIGNING_KEY | - | Inngest 署名キー |
REFRAIN_API_KEY | - | デフォルト API キー |
| 変数 | 説明 |
|---|---|
ANTHROPIC_API_KEY | Anthropic API キー |
OPENAI_API_KEY | OpenAI API キー |
GOOGLE_GENERATIVE_AI_API_KEY | Gemini API キー |
AZURE_RESOURCE_NAME | Azure OpenAI リソース名 |
AZURE_API_KEY | Azure OpenAI API キー |
AWS_REGION | Bedrock の AWS リージョン |
AWS_ACCESS_KEY_ID | Bedrock の AWS アクセスキー |
AWS_SECRET_ACCESS_KEY | Bedrock の AWS シークレットキー |
GOOGLE_VERTEX_PROJECT | Vertex の Google Cloud プロジェクト |
GOOGLE_VERTEX_LOCATION | Vertex の Google Cloud リージョン |
環境の設定
.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-..."
データベースマイグレーション
npx @refrainai/cli db:migrate
サーバーの起動
npx @refrainai/cli serve
| エンドポイント | メソッド | 説明 |
|---|---|---|
/api/runbooks | GET | 手順書一覧 |
/api/runbooks | POST | 手順書の作成 |
/api/runbooks/:id | GET | 手順書の詳細 |
/api/jobs | POST | ジョブの作成（execute/generate/self-heal） |
/api/jobs | GET | ジョブ一覧 |
/api/jobs/:id | GET | ジョブの詳細 |
/api/jobs/:id/stream | GET | リアルタイム更新の SSE ストリーム |
/api/jobs/:id/approve | POST | 待機中ジョブの承認 |
/api/jobs/:id/reject | POST | 待機中ジョブの拒否 |
/api/jobs/:id/cancel | POST | 実行中ジョブのキャンセル |