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 与工作流引擎怎么选

相关页面