メインコンテンツへ移動
ドキュメントはじめるクイックスタート
はじめに · 10 分

クイックスタート

アカウントを登録し、コンソールに入り、テンプレートまたは AI アシスタントを使用して、完全なワークフローを 10 分で実行できます。

この記事では、コードを記述したり途中で何もインストールしたりすることなく、「Web サイトを開くだけ」から「実際のワークフローを実行する」までを説明します。読み進めていくと、Braidrun ワークフローで最も一般的に使用されるほぼすべての概念がわかるようになります。

始める前に

必要なものはほとんどありません。

  • 電子メールを受信できる電子メール アドレス - 登録と電子メールの確認に使用されます。
  • OpenAI / Anthropic / DeepSeek / Kim のいずれかの API キー (オプション) - 最初にドライランを実行して、キーなしでデータ フローを確認できます。実際に LLM を調整する場合にのみ必要になります。
  • 10分から15分の集中時間。

パノラマ プレビュー: このプレビューで期待できること

以下に順に辿っていきます。各ステップでは、無味乾燥な操作マニュアルではなく、「なぜこれを行うのか」を説明します。

  1. アカウント登録→ログイン
  2. メイン コンソールについて理解するには、「ワークフロー」ページに移動してください
  3. テンプレート ライブラリから既製のワークフローを複製する
  4. ドライランで構造を確認する
  5. LLM キーをバインドする (BYOK)
  6. 一度実行してリアルタイムのイベント ストリームを理解する
  7. cron をハングアップし、毎日自動的に実行されるようにします

ステップ 1 · アカウントを登録する

1.1 登録ページを開く

ホームページの右上隅にある「ログイン」をクリックするか、ログインページの下部にある「アカウントの作成」をクリックするか、直接アクセスしてください。 /register。

1.2 招待コードまたはオープン登録

Braidrun は現在、招待制のクローズド ベータ段階にあります。これは次のことを意味します。

  • 登録を完了するには招待コードが必要です。
  • 招待コードをお持ちでない場合は、ホームページの「招待コード申請」フォームにメールアドレスをご記入ください。定員が空き次第、まずはご連絡させていただきます。

招待コードを取得したら、メールアドレス + パスワード + 招待コードを入力するだけです。 Google/GitHub OAuth を使用してワンクリックでログインすることもできます (この方法には招待コードは必要ありませんが、管理者の承認を待つ必要があります)。詳しい手順については、 登録とログイン。

1.3 電子メールの検証とアクティベーション

フォームを送信すると、確認メールが届きます。内部のリンクをクリックしてアカウントを有効にします。アクティブ化する前は、ページを参照することはできますが、ワークフローを作成/保存/実行することはできません。上部にオレンジ色のリマインダー バナーが表示されます。

メールを受信しませんでしたか?

まずスパムボックスをチェックしてください。それでも問題が解決しない場合は、「アカウント設定」ページに移動し、「確認メールを再送信」をクリックしてください。 15 分以上経っても受信できない場合は、メール ドメインが外部の確認メールをブロックしている可能性があります。メールアドレスを変更してみてください。

ステップ 2 · ワークフロー コンソールに入る

2.1 左側のメインナビゲーション

ログインすると、ホームページが表示されます。左側には固定ナビゲーション バーがあり、必ず使用します。

  • ワークフロー — あなたの主戦場。すべてのワークフローがここにリストされます。
  • テンプレート — 240 以上のプリセットワークフロー。クローンしてすぐに使えます。
  • モジュール — 120 以上の再利用可能なモジュール + あなた自身が Promote したモジュール。
  • 実行履歴 — 最近のすべての実行のリスト。
  • スケジュール — タイミング/Webhook トリガー エントリ。
  • 承認 — ワークフローが「手動承認」ステップの場合、承認者はここから承認します。
  • 認証情報 — すべての API キーはここに配置され、暗号化されて保存されます。

2.2 ホームページへの 3 つの簡単な入り口

ホームページは何もない空間ではありません。次の 3 つの開始点が提供されます。

  1. 新しい空のワークフローを作成する — 空白のキャンバスから始めます。プラットフォームに慣れた後でこれを選択することをお勧めします。
  2. テンプレートからクローンを作成する — このガイドはこのパスに従います。すぐに始めましょう。
  3. AI アシスタントに生成させる — 右下隅の FAB は、サイド AI アシスタントを開きます。自然言語を使用してやりたいことを説明すると、最初の草案が得られます。

ステップ 3 · テンプレート ライブラリからクローンを作成する

3.1 ビジネスに最も近いテンプレートを選択する

左開き テンプレート。左上隅には分類フィルターがあります (運用自動化、広告配信、データ分析、iOS 開発、コンテンツ作成、コンプライアンス レビューなど)。右上隅には検索ボックスとタグフィルターがあります。

初めては、次の 2 つのカテゴリのいずれかを選択することをお勧めします。

  • 「デイリーニュースダイジェスト」 — ロジックはシンプルで、手順は少なく、完全なデータ フローを確認できます。
  • 「ASA ウィークリーレポート」 — スケジューリング + サブワークフロー + Slack 配信を使用した実際のビジネス シナリオ。

3.2 テンプレートカードの読み取り

クリックしてご覧ください:

  • 「説明」 - 何をするのか
  • 「必須の資格情報」 - 実行時にどのキーを入力する必要がありますか?
  • 「入力/出力の例」 - 典型的な結果の代表
  • 「推定所要時間/費用」 - 実行にはおよそ何分、何ドルかかりますか?

3.3 ワークスペースへのクローン作成

右上隅をクリックします 「このテンプレートを使用してください」。確認後、プラットフォームは /workflows 以下に独立したコピーが生成されます。後でどのように変更しても、元のテンプレートには影響しません。

ステップ 4 · ドライランを使用して、最初に構造を確認します。

4.1 なぜドライランが必要なのでしょうか?

ドライランの中心的な価値は「ゼロコスト」です。これは完全な DAG を通過しますが、すべての LLM 呼び出しと外部の副作用 (メッセージの送信、データベースの書き込み、支払いの差し引きなど) を安全な no-ops に置き換えます。以下を確認できます。

  • 変数はどこに流れますか - 引用符付き {{...}} 誤字脱字はありませんか？
  • 条件によってスキップされるステップ
  • テンプレートがどの資格情報に依存するか - 資格情報センターで何を構成するかを事前に知っておく

4.2 エディターで予行演習を開始する

  1. ワークフロー エディターの上部で、 「処刑」。
  2. ダイアログボックスの「ドライラン（LLMを調整しない/副作用を生成しない）」にチェックを入れます。
  3. テンプレートのプロンプトに従って必要なパラメータをいくつか入力し、残りはデフォルトのままにします。
  4. 「実行開始」をクリックします。エディターは自動的に実行の詳細ビューに切り替わります。
実行の詳細ページを理解する

上部はガント チャート (各ステップのバーは所要時間を表します)、左下はステップ リスト、右下は選択したステップの入力/出力/変数のスナップショットです。ドライランが完了すると、すべてのステップが緑色の COMPLETED または灰色の SKIPPED になるはずです。

ステップ 5 · LLM キーを構成する (BYOK)

5.1 BYOKとは何ですか

「自分の鍵を持ってきてください」。 OpenAI / Anthropic などのプロバイダーから API キーを取得し、それを Braidrun に追加すると、ユーザーに代わって呼び出すことができます。利点:

  • トークンの消費は自分の LLM アカウントに直接記録され、プラットフォームが価格を引き上げることはありません。
  • Claude Opus、GPT-5 などの独自のアカウントの高度なモデルは、プラットフォームの統一保証なしで使用できます。
  • キーのローテーション/取り消しは完全にあなた次第です。

5.2 キーを取得する

最も一般的なもの:

5.3 認証情報に保存する

  1. 開く 認証情報。
  2. 「新しい資格情報」をクリックします。
  3. タイプとして api_key を選択します。などの認識可能な名前を選択します。 openai_main、anthropic_personal;Value には、プロバイダーから取得したキーが貼り付けられます。
  4. 保存します。プラットフォームはすぐに AES-256-GCM を使用してデータベースを暗号化します。その後、このフィールドは上書きのみ可能となり、読み取ることはできなくなります。

より完全な説明 (第 3 レベルの名前空間、プロバイダー バインディング、ローテーション プロセス) については、を参照してください。 認証情報 そして BYOK · 自分の LLM Key を利用。

ステップ6・実際に走ってみる

6.1 実行の開始

  1. ワークフローエディターに戻り、上部の「実行」をクリックします。
  2. 今度はダイアログボックスで キャンセル 予行運転を確認します。
  3. 必要なパラメータを再度入力します。通常は、初回のドライランと同じです。
  4. 「実行開始」をクリックします。

6.2 右側のリアルタイム イベント ストリームを理解する

ページの右側は WebSocket を通じてリアルタイムに配信されるイベントストリームです。各行が 1 つのイベントで、カテゴリ別にフィルタリングできます。

  • Agent の発言 —— Agent の中間出力で、group_chat ステップで最もよく見られます。
  • LLM 呼び出し —— 各モデル呼び出しの要約で、入力 / 出力の token 数を含みます。
  • ツール呼び出し —— Agent がどのツールを呼び出したか。展開すると引数と戻り値を確認できます。
  • 外部メッセージ —— ワークフローが Slack / Telegram などのチャネルに送信したメッセージの記録。

その他のイベントカテゴリの説明は以下を参照してください 実行の監視とログ記録。

6.3 結果と製品を見る

実行後、上部にある「実行の詳細を表示」をクリックします。

  • ガント チャートの各緑色のバーは成功したステップです。マウスを移動すると、にかかった時間が表示されます。
  • ステップをクリックすると、その入力/出力/ログ/変数のスナップショットが表示されます。
  • 製品欄ではMarkdown/Excel/スクリーンショット等をプレビューまたはダウンロードできます。

ステップ 7 ·cron を切断し、自動的に実行させます。

7.1 新しいスケジュールを作成する

  1. 左側の「スケジュール管理」→「新規スケジュール」。
  2. ターゲット ワークフローとして、先ほど実行したワークフローを選択します。
  3. タイプとして cron を選択します。式を埋めてください 0 8 * * *(毎日午前 8 時);タイムゾーンとしてアジア/上海を選択します。
  4. ワークフローに変数がある場合は、「パラメーターのデフォルト」にこのスケジュールのバッチのデフォルト値を入力します (スケジュールされた各トリガーはこれらの値で開始されます)。
  5. 保存します。リストにはもう 1 つの項目があり、「次回トリガー時間」がリアルタイムに計算されて表示されます。
標準の 5 セグメント cron のみに対応

式は「分 時 日 月 曜日」の 5 セグメント形式である必要があります。Quartz スタイルの 6 / 7 セグメント式（秒の桁や ? のプレースホルダーが余分にあるもの、例: 0 0 8 * * ?）は保存時にエラーにはなりませんが、決してトリガーされません。

7.2 スケジュールが重複しないようにする方法

プラットフォームは、マルチインスタンス展開下で分散ロックを自動的に実行します。同じスケジュールは、同じ瞬間に 1 台のマシンでのみトリガーされます。繰り返しの実行について心配する必要はありません。

タイミング スケジューリングは、インターバル/ワンタイム モードでも設定できます。詳細については、を参照してください。 スケジュール実行。

これを実行した後、あなたはすでに方法を知っています

  • 登録/ログイン/メール認証の完了プロセス
  • テンプレートライブラリのクローン→エディターの予行→実際の実行の基本ループ
  • Credential Center の役割と BYOK の重要性
  • リアルタイムイベントストリーム + 実行詳細ページを読み取る権限
  • ワークフローを cron 自動実行入口に吊るす

次に見るべきもの