メインコンテンツへ移動
開発者向け

AI ワークフローを 1 つの API として使う

トリガー、結果の照会、承認、成果物の取得、すべて REST です——モデル呼び出し、リトライ、キューを自分で維持する必要はありません。

無料で始めるAPI ドキュメントを見る →
14 個の v1 エンドポイント6 種類の権限スコープ7 種類の言語サンドボックス
braidrun v1 APIREST · JSON
# 実行を 1 回トリガーします
POST /api/webhooks/{id}/trigger
→ {"executionId": "exec_51a2"}

# 状態をポーリングします：今回は人手の承認で停止しました
GET  /api/v1/executions/exec_51a2
→ {"status": "AWAITING_APPROVAL"}

# 承認後に続行します（数値は先に変更してから承認できます）
POST /api/v1/approvals/{approvalId}/approve

# 完了後に結果と成果物を取得します
GET  /api/v1/executions/exec_51a2/result
GET  /api/v1/executions/exec_51a2/artifacts
接続の道筋

15 分で、Webhook の作成から最初の結果の取得まで

4 つの HTTP リクエストで全プロセスを通せます。SDK は不要で、リクエストを送れる言語であれば接続できます。

01Webhook を作成し、URL と Key を取得するコンソールでワークフローに Webhook トリガーを追加すると専用の URL が得られます。次に WEBHOOK_TRIGGER スコープの API Key を 1 つ作成します。
WEBHOOK_TRIGGERX-API-Key
021 回の POST で実行をトリガーするJSON のトップレベルのフィールドは同名のワークフロー変数へ自動マッピングされ、variableMapping で明示的にマッピングすることもできます。payload の上限は 1MB です。
POST≤ 1MB
03実行状態をポーリングし、結果を取得する返された executionId で実行詳細を照会します。完了後は result エンドポイントから出力を取得し、artifacts エンドポイントからファイルをダウンロードします。
GET /api/v1/executions/{id}EXECUTION_READ
04人手の審査が必要なアクションは承認 API を通す実行は manual_approval ステップで停止します。承認エンドポイントで承認待ちの項目を一覧表示し、承認または却下します。却下またはタイムアウトの場合は何も変更されません。
APPROVAL_RESPONDタイムアウト時は自動却下
terminalX-API-Key · JSON ≤ 1MB
# ステップ 2：あなたのシステムから POST を 1 回送信します
curl -X POST https://your-host/api/webhooks/{id}/trigger \
  -H "X-API-Key: <your-api-key>" \
  -d '{"ticket_id": "T-1024", "lang": "zh"}'
# トップレベルのフィールドは同名のワークフロー変数へ自動マッピングされます
→ {"executionId": "exec_51a2"}

# ステップ 3：状態をポーリングし、完了したら結果を取得します
curl https://your-host/api/v1/executions/exec_51a2/result \
  -H "X-API-Key: <your-api-key>"
能力一覧

コードを書く人が気にする 6 つのこと

7 種類の言語のサンドボックスコードステップPython、JavaScript、TypeScript、Bash、Ruby、Lua、CLI のいずれも記述できます。変数は WF_VAR_* 環境変数として注入され、デフォルトのタイムアウトは 30 秒、本番環境では外部通信が制御された Docker サンドボックスで実行されます。
WF_VAR_*30s timeout
YAML 定義で、あなたの Git フローに乗せる1 つのワークフローは 1 つの YAML ファイルです：コミット、diff、ロールバックはすべて使い慣れたリポジトリで行えます。キャンバスと YAML は双方向に同期し、どちらを変更しても構いません。
workflow.yamlgit diff
MCP であなた自身のツールを接続する社内サービスを MCP Server にラップして Agent に接続すれば、AI ステップはあなたのシステムを直接呼び出せます。プラットフォームがコネクタを提供するのを待つ必要はありません。
MCPagent tools
ブレークポイントデバッガー9 種類のブレークポイントは、ヒットすると一時停止し、変数を変更してから続行します。失敗後は指定したステップから再実行し、完了済みの LLM ステップは重複して課金されません。
9 breakpointsプロ
14 エンドポイントの v1 API、最小権限実行のトリガー、結果の照会、承認、成果物のダウンロードには、それぞれ独立した権限スコープがあります。6 種類のスコープを必要に応じて組み合わせ、接続する各システムに個別の Key を発行します。
v16 scopes
チェーントリガー DELAYED_COMPLETIONA の完了後 N 秒で B を自動トリガーし、maxRuns の上限を設定できます。長いプロセスをいくつかの区間に分割し、区間ごとにログとコストを個別に確認します。
DELAYED_COMPLETIONmaxRuns
正直な境界

3 つのことを、先にお伝えします

接続の途中で初めて気づくことを避けるためです。

数百もの SaaS コネクタはありません外部システムへの呼び出しはコードステップ内に記述するか、MCP ツールにラップして Agent に接続します。コードを書くチームにとって、このステップは数行の HTTP リクエストにすぎません。
実行前のコスト見積もり API はありません各実行の token 使用量とコストは実行ごとに記録され、事後の計算は細かいです。ただし実行前に見積もりは得られないため、予算管理は承認ゲートと maxRuns に依存します。
制限を先に明示しますWebhook payload の上限は 1MB、コードステップのデフォルトタイムアウトは 30 秒、HMAC-SHA256 署名は互換モードとしてのみ保持され、新規接続では API Key を使用します。
ドキュメントの入口

接続前に読む価値のある 3 篇

GET /api/v1/*v1 API リファレンス14 エンドポイントのリクエストとレスポンスのフィールド、エラーコード、および 6 種類の権限スコープの設定方法。ドキュメントを開く →POST /api/webhooks/*Webhook トリガーURL と Key の取得、変数マッピングのルール、HMAC 互換モード、1MB 制限。ドキュメントを開く →workflow.yamlYAML 構文8 種類のステップ種別、および condition、retry、manual_approval といった修飾子の記述方法。ドキュメントを開く →
最初のワークフローをあなたのシステムに接続する
Free プランでワークフローを組み立てて手動で通すことができます。Webhook トリガーや定期スケジューリングが必要になったら Pro にアップグレードしてください。
無料で始めるAPI ドキュメントを見る