Braidrun SDK

使用涵蓋 12 種語言的 13 個型別安全用戶端，呼叫工作流程、執行、產物、審批與 Webhook API。

Braidrun SDK 是開放平台 API 的官方型別安全用戶端集合。它將工作流程、執行、產物、人工審批與 Webhook 端點封裝成各語言熟悉的方法和資料模型，讓你不必手動編寫 HTTP 請求與回應類型。

官方原始碼儲存庫github.com/Braidrun/braidrun-sdk所有用戶端均由同一份 OpenAPI 3.0.3 描述產生，並保持一致的 API 1.0 介面與模型。

查看儲存庫

支援的用戶端

儲存庫提供 13 個用戶端實作，涵蓋 12 種語言。每個目錄都是獨立用戶端，包含套件中繼資料、介面模型、測試，以及該語言完整的端點文件。

API 涵蓋範圍

各語言用戶端涵蓋相同的公開能力，方法名稱會依語言慣例自動轉換。

能力領域	可以做什麼
工作流程	列出與讀取工作流程，並非同步啟動一次執行。
執行	查詢狀態、歷史與最終結果，或取消仍在執行的任務。
產物	讀取一次執行所產生的檔案與產物中繼資料。
人工審批	讀取待審批項目，並提交核准或拒絕決定。
Webhook	註冊與管理 Webhook、查看統計資料，並透過 Webhook 觸發工作流程。

快速開始

在「帳號設定 → API 金鑰」建立金鑰，並只授予呼叫所需的 scope。
選擇符合你技術堆疊的用戶端，並開啟該目錄的 README。
從原始碼安裝相依套件，並透過環境變數設定 API Key。
建立 API 用戶端，先呼叫工作流程清單以確認連線與權限。

terminalbash

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

list_workflows.pypython

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)

目前以原始碼形式提供

SDK 目前統一透過 GitHub 原始碼儲存庫提供，各語言套件管理器的發布狀態可能不同。請以對應目錄的 README 為準，不要假設所有用戶端都已發布至公用套件儲存庫。

驗證與權限

建議透過環境變數或密鑰管理服務讀取以 dyk_ 開頭的 API Key，並使用 Bearer Header。切勿將真實密鑰寫入原始碼、日誌或瀏覽器前端。每個端點仍會驗證對應的 scope；用戶端具備型別安全並不代表會自動取得權限。

Webhook 管理介面的驗證方式不同

SDK 也會產生 Webhook 管理介面，但 /api/webhooks 下的管理端點使用瀏覽器工作階段或管理員服務帳號，不接受一般的細粒度開放平台 API Key。Webhook 觸發端點仍可使用具備 WEBHOOK_TRIGGER scope 的開放平台密鑰。

當 API 傳回 429 時，請遵循 Retry-After，並搭配 X-RateLimit-Limit 與 X-RateLimit-Window 調整重試頻率。

如何選擇 SDK 或工作流程引擎

項目	適合場景	執行位置
`braidrun-sdk`	從你的應用程式呼叫 Braidrun 雲端平台 API，並使用各語言的型別與模型。	你的應用程式 + Braidrun 雲端平台
`braidrun-workflow`	在自己的環境中執行 YAML 工作流程，或將執行階段嵌入 Kotlin/JVM 專案。	由你管理的本機、伺服器或 CI 環境

查看兩個專案的完整介紹

支援的用戶端

伺服器端與後端

Web 與 Node.js

行動端與跨平台

API 涵蓋範圍

快速開始

驗證與權限

如何選擇 SDK 或工作流程引擎

相關頁面