Bỏ qua nội dung chính
DocsNền tảng mở AISDK chính thức
Nền tảng mở · 12 ngôn ngữ

Braidrun SDK

Dùng 13 client an toàn kiểu cho 12 ngôn ngữ để gọi API workflow, lượt thực thi, artifact, phê duyệt và webhook.

Braidrun SDK là bộ sưu tập client an toàn kiểu chính thức dành cho API nền tảng mở. SDK đóng gói các endpoint về workflow, lượt thực thi, artifact, phê duyệt thủ công và webhook thành các phương thức và mô hình dữ liệu quen thuộc trong từng ngôn ngữ, nhờ đó bạn không phải tự viết yêu cầu HTTP và kiểu phản hồi.

Kho mã nguồn chính thứcgithub.com/Braidrun/braidrun-sdkĐược tạo từ cùng một đặc tả OpenAPI 3.0.3, tất cả client dùng giao diện và mô hình API 1.0 nhất quán.
Xem kho mã

Các client được hỗ trợ

Kho mã cung cấp 13 bản triển khai client cho 12 ngôn ngữ. Mỗi thư mục là một client độc lập, có metadata gói, mô hình API, bộ kiểm thử và tài liệu endpoint đầy đủ cho ngôn ngữ đó.

Máy chủ và backend

C#GoJavaKotlinPHPPythonRubyRust

Web và Node.js

JavaScriptTypeScript · FetchTypeScript · Axios

Di động và đa nền tảng

DartSwift 5

Phạm vi API

Mỗi client ngôn ngữ đều hỗ trợ cùng một tập tính năng công khai, với tên phương thức được điều chỉnh theo quy ước của ngôn ngữ đó.

Nhóm tính năngBạn có thể làm gì
Đã cập nhậtLiệt kê và đọc workflow, đồng thời khởi chạy một lượt thực thi bất đồng bộ.
Thực hiệnTruy vấn trạng thái, lịch sử và kết quả cuối cùng, hoặc hủy một lượt thực thi vẫn đang chạy.
Sản phẩm đầu raĐọc các tệp và metadata artifact do một lượt thực thi tạo ra.
Chấp thuận thủ côngĐọc các yêu cầu phê duyệt đang chờ và gửi quyết định phê duyệt hoặc từ chối.
WebhookĐăng ký và quản lý webhook, xem số liệu thống kê và kích hoạt workflow qua webhook.

Bắt đầu nhanh

  1. Tạo khóa trong “Cài đặt tài khoản → Khóa API” và chỉ cấp các scope cần thiết cho các lệnh gọi.
  2. Chọn client phù hợp với stack công nghệ của bạn và mở tệp README trong thư mục của client đó.
  3. Cài các dependency từ mã nguồn và cấu hình API Key qua biến môi trường.
  4. Tạo một API client, sau đó gọi danh sách workflow trước để kiểm tra kết nối và quyền truy cập.
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)
Hiện được phân phối dưới dạng mã nguồn

SDK hiện được phân phối qua kho mã nguồn GitHub; mức độ hỗ trợ trên trình quản lý gói của từng ngôn ngữ có thể khác nhau. Hãy đọc tệp README trong thư mục tương ứng và đừng mặc định rằng mọi client đều đã được phát hành lên kho gói công khai.

Xác thực và phân quyền

Nạp API Key bắt đầu bằng dyk_ từ biến môi trường hoặc dịch vụ quản lý bí mật, rồi dùng header Bearer. Tuyệt đối không ghi khóa thật vào mã nguồn, log hoặc mã frontend chạy trên trình duyệt. Mỗi endpoint vẫn kiểm tra scope bắt buộc; client an toàn kiểu không tự động cấp quyền.

Quản lý webhook sử dụng cơ chế xác thực khác

SDK cũng tạo các API quản lý webhook, nhưng các endpoint quản lý dưới /api/webhooks sử dụng phiên trình duyệt hoặc tài khoản dịch vụ quản trị viên và không chấp nhận API Key tiêu chuẩn có scope chi tiết của nền tảng mở. Endpoint kích hoạt webhook vẫn có thể dùng khóa nền tảng mở với scope WEBHOOK_TRIGGER.

Khi API trả về mã 429, hãy tuân theo Retry-After và dùng X-RateLimit-Limit cùng X-RateLimit-Window để điều chỉnh nhịp thử lại.

SDK hay công cụ thực thi workflow?

ChổiPhù hợp với cảnhMôi trường chạy
braidrun-sdkGọi API nền tảng đám mây Braidrun từ ứng dụng của bạn bằng các kiểu và mô hình dành riêng cho từng ngôn ngữ.Ứng dụng của bạn + nền tảng đám mây Braidrun
braidrun-workflowChạy workflow YAML trong môi trường của bạn hoặc nhúng runtime vào dự án Kotlin/JVM.Môi trường cục bộ, máy chủ hoặc CI do bạn quản lý

Xem tổng quan đầy đủ về cả hai dự án

Các trang liên quan