Braidrun SDK

Braidrun SDK は、オープンプラットフォーム API の公式タイプセーフクライアント集です。ワークフロー、実行、成果物、人による承認、Webhook の各エンドポイントを、言語ごとに使い慣れたメソッドとデータモデルで提供するため、HTTP リクエストやレスポンス型を手書きする必要がありません。

対応クライアント

リポジトリには 12 言語をカバーする 13 のクライアント実装があります。各ディレクトリは独立したクライアントで、パッケージメタデータ、API モデル、テスト、その言語向けの完全なエンドポイントドキュメントを収録しています。

API の対応範囲

各言語のクライアントは同じ公開機能をカバーし、メソッド名は言語の慣習に合わせて自動変換されます。

クイックスタート

1. 「アカウント設定 → API キー」でキーを作成し、呼び出しに必要なスコープだけを付与します。
2. 技術スタックに合うクライアントを選び、そのディレクトリの README を開きます。
3. ソースから依存関係をインストールし、環境変数で API Key を設定します。
4. API クライアントを作成し、まずワークフロー一覧を呼び出して接続と権限を確認します。

python -m pip install "git+https://github.com/Braidrun/braidrun-sdk.git#subdirectory=python"

import os
import braidrun_sdk

configuration = braidrun_sdk.Configuration(
    host="https://braidrun.com",
    access_token=os.environ["BRAIDRUN_API_KEY"],
)

with braidrun_sdk.ApiClient(configuration) as client:
    workflows = braidrun_sdk.WorkflowsApi(client)
    result = workflows.list_workflows()
    print(result)

認証と権限

dyk_ で始まる API Key は環境変数またはシークレット管理サービスから読み込み、Bearer Header を使用することを推奨します。実際のキーをソースコード、ログ、ブラウザーのフロントエンドに書き込まないでください。各エンドポイントでは対応するスコープが引き続き検証されます。クライアントがタイプセーフでも、権限が自動的に付与されるわけではありません。

API が 429 を返した場合は Retry-After に従い、X-RateLimit-Limit と X-RateLimit-Window を使って再試行間隔を調整してください。

SDK とワークフローエンジンの選び方

2 つのプロジェクトの詳しい紹介を見る

関連ページ

• APIオープンプラットフォームの概要
• APIキー管理
• 認証とレート制限
• v1 エンドポイントの完全なリファレンス
• Braidrun SDK GitHub リポジトリ ↗