Toàn bộ tham chiếu cho điểm kết thúc v1

Nền tảng mở v1 có 14 điểm (3 cho workflow, 4 cho việc thực hiện, 5 cho sự chấp thuận, 2 cho đồ tạo tác), tất cả được gắn vào dưới tiền tố / api/v1/*. Mỗi điểm kết thúc liệt kê phạm vi cần thiết, định dạng yêu cầu, định dạng trả lời và một ví dụ cong.

Đã Cập nhật

GET /api/v1/workflows

Scope: WORKFLOW_READ

Danh sách các workflow hiển thị cho chủ hiện tại Token. Hỗ trợ paging:.page = 1&ize = 50 (mặc định 50, tối đa 200).

curl https://braidrun.com/api/v1/workflows?page=1&size=20 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

Đáp ứng:

{
  "items": [
    {
      "id": "wf-001",
      "name": "Daily ASA report",
      "ownerId": "u-alice",
      "workflow": [...]
    }
  ],
  "total": 17,
  "page": 1,
  "size": 20
}

GET /api/v1/workflows/{id}

Scope: WORKFLOW_READ

Đọc một định nghĩa công việc duy nhất (bằng cách chia sẻ / kiểm tra giấy phép).

curl https://braidrun.com/api/v1/workflows/wf-001 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

POST /api/v1/workflows/{id}/executions

Scope: WORKFLOW_EXECUTE

Bắt đầu một cuộc hành hình mới. Yêu cầu cơ thể hỗ trợ đầu vào và hiệu lực trường vẽ. Phản ứng 202 chấp nhận (hành hình sẽ xảy ra khi co thắt).

curl -X POST https://braidrun.com/api/v1/workflows/wf-001/executions \
  -H "Authorization: Bearer dyk_<id>_<secret>" \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": {
      "customer_id": "12345",
      "report_date": "2026-04-30"
    },
    "enableMonitoring": true
  }'

Đáp ứng (02 chấp nhận):

{
  "executionId": "exec_a3b9c8...",
  "status": "PENDING",
  "workflowId": "wf-001",
  "startedAt": 1735632891234
}

Sau khi nhận được giấy phép thực thi, sử dụng GET /api/v1/executions/{id} Tình trạng ô nhiễm.

Hạng thực hiện

GET /api/v1/executions

Scope: EXECUTION_READ

Đã đăng danh sách thực thi cho chủ hiện tại. Có thể được lọc bởi?workLd= ?status = .

curl 'https://braidrun.com/api/v1/executions?status=RUNNING&size=10' \
  -H "Authorization: Bearer dyk_<id>_<secret>"

GET /api/v1/executions/{id}

Scope: EXECUTION_READ

Tên.

curl https://braidrun.com/api/v1/executions/exec_a3b9c8 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

Nghĩa là:

GET /api/v1/executions/{id}/result

Scope: EXECUTION_READ

Trả lại toàn bộ đệ trình thực thi, bao gồm các bước lặp lại + thời gian + kết quả tổng thể. Giá trị này chỉ sẵn sàng sau khi tình trạng kết thúc (COMPERED/FAILED/CIDEDEDEDEDEDEDEDEDEDEEDEEDEDEDEDEDEDEDEDEDEDEDEDEDEDEEDEDETETETETETETETETETETETETETTTTTTTTTTTTTETTETTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTBTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT.

curl https://braidrun.com/api/v1/executions/exec_a3b9c8/result \
  -H "Authorization: Bearer dyk_<id>_<secret>"

POST /api/v1/executions/{id}/cancel

Scope: EXECUTION_CANCEL

Hủy bỏ thực hiện đang chạy. Trả về năm 404 nếu thực hiện xong hay không tồn tại.

curl -X POST https://braidrun.com/api/v1/executions/exec_a3b9c8/cancel \
  -H "Authorization: Bearer dyk_<id>_<secret>"

Chấp nhận

Khi execution đi đến bước manual_approval, nó sẽ tạm dừng và tạo một bản ghi phê duyệt. 5 endpoint bên dưới đều yêu cầu scope APPROVAL_RESPOND: hệ thống bên ngoài có thể liệt kê mục chờ phê duyệt, đọc chi tiết phê duyệt (bao gồm dữ liệu biểu mẫu có thể chỉnh sửa), phê duyệt hoặc từ chối. Sau khi phê duyệt, execution tiếp tục; nếu từ chối, execution dừng; nếu vượt quá timeout cấu hình phê duyệt, hệ thống sẽ tự động từ chối.

GET /api/v1/approvals

Scope: APPROVAL_RESPOND

Hãy liệt kê các hồ sơ chấp thuận được hiển thị cho người sở hữu biểu tượng hiện thời. Bộ lọc bởi ?status = (v. d. PENDING); paginate with ?page = 1&ize = 20 (mặc định 20, tối đa 200).

curl 'https://braidrun.com/api/v1/approvals?status=PENDING&page=1&size=20' \
  -H "Authorization: Bearer dyk_<id>_<secret>"

Đáp ứng:

{
  "approvals": [
    {
      "id": "apr-001",
      "executionId": "exec_a3b9c8...",
      "workflowId": "wf-001",
      "stepName": "review_bid_changes",
      "status": "PENDING",
      "approvalMessage": "42 条出价调整待确认",
      "timeout": 86400,
      "createdAt": 1735632891234,
      "expiresAt": 1735719291234,
      "reviewableGroups": [
        {
          "name": "bid_changes",
          "title": "出价调整",
          "items": [],
          "itemsCount": 42
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "size": 20
}

GET /api/v1/approvals/{id}

Scope: APPROVAL_RESPOND

Hãy đọc một sự chấp thuận đầy đủ: trạng thái / bước / chấp thuận Message / endsage, cộng với các mục đầy đủ trong bản ôn lại có thể xem xét (các dữ liệu hàng và các định nghĩa cột).

curl https://braidrun.com/api/v1/approvals/apr-001 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

GET /api/v1/approvals/execution/{executionId}

Scope: APPROVAL_RESPOND

Tra cứu bằng cách thực hiện: trả lại tất cả các hồ sơ được chấp thuận do thực hiện (các món đồ cũng bị lột ở đây). Khi thăm dò tình trạng tử hình, hãy dùng nó để tìm sự chấp thuận hành động.

curl https://braidrun.com/api/v1/approvals/execution/exec_a3b9c8 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

POST /api/v1/approvals/{id}/approve

Scope: APPROVAL_RESPOND

Chấp thuận và để cho việc hành hình tiếp diễn. Cả hai trường yêu cầu trên cơ thể đều tùy chọn: chú thích là ghi chú của người xem; chỉnh sửa Items đệ trình một tập hợp các hàng được chỉnh sửa bởi tên nhóm — loại bỏ nó để chấp nhận dữ liệu gốc là-is, hoặc bao gồm nó và động cơ chạy chỉ các hàng bạn đệ trình (các bản đồ này cho phép dạng chấp nhận, ví dụ. điều chỉnh một giá thầu trước khi ứng dụng).

curl -X POST https://braidrun.com/api/v1/approvals/apr-001/approve \
  -H "Authorization: Bearer dyk_<id>_<secret>" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "确认执行，两条出价手动下调",
    "editedItems": {
      "bid_changes": [
        {"keyword": "photo editor", "newBid": 0.65},
        {"keyword": "collage maker", "newBid": 0.55}
      ]
    }
  }'

Câu trả lời là hồ sơ về sự chấp thuận đã cập nhật (status = APPROVED). Nếu không có sự chấp thuận, thì số tiền đó sẽ được ứng dụng.

POST /api/v1/approvals/{id}/reject

Scope: APPROVAL_RESPOND

Hãy từ chối sự chấp thuận; rồi việc thực thi dừng lại và không có thay đổi nào cả. Trường bình luận trong yêu cầu cơ thể ghi lại lý do bị từ chối.

curl -X POST https://braidrun.com/api/v1/approvals/apr-001/reject \
  -H "Authorization: Bearer dyk_<id>_<secret>" \
  -H "Content-Type: application/json" \
  -d '{"comment": "本周预算已用完，先不调整"}'

Loại sản phẩm

GET /api/v1/executions/{id}/artifacts

Scope: ARTIFACT_READ

Liệt kê mọi sản phẩm tạo ra bởi thực hiện này (bao gồm tập tin, báo cáo, ảnh chụp màn hình, v. v. được tạo ra tại mỗi bước).

curl https://braidrun.com/api/v1/executions/exec_a3b9c8/artifacts \
  -H "Authorization: Bearer dyk_<id>_<secret>"

Đáp ứng:

{
  "artifacts": [
    {
      "id": "art-001",
      "name": "daily-report.xlsx",
      "path": "executions/exec_a3b9c8/.../daily-report.xlsx",
      "storageKey": "executions/exec_a3b9c8/.../daily-report.xlsx",
      "downloadUrl": "/api/executions/exec_a3b9c8/artifacts/art-001/download",
      "previewable": false
    }
  ],
  "total": 1
}

GET /api/v1/executions/{id}/artifacts/{aid}

Scope: ARTIFACT_READ

Siêu thông tin của một sản phẩm, bao gồm cả trường Url. Ứng dụng khách dùng downloadUrl để lấy nội dung thật (không phải qua kết thúc v1, dùng chỉ tiêu miễn phí).

curl https://braidrun.com/api/v1/executions/exec_a3b9c8/artifacts/art-001 \
  -H "Authorization: Bearer dyk_<id>_<secret>"

Hoàn thành dòng chảy cURL: kích hoạt ô ô thăm dò ý kiến tôm được sản phẩm

# 1. 启动执行
EXEC_ID=$(curl -s -X POST \
  https://braidrun.com/api/v1/workflows/wf-001/executions \
  -H "Authorization: Bearer $DYK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"inputs": {"customer_id": "12345"}}' \
  | jq -r .executionId)

# 2. 轮询直到完成
while true; do
  STATUS=$(curl -s \
    "https://braidrun.com/api/v1/executions/$EXEC_ID" \
    -H "Authorization: Bearer $DYK_TOKEN" \
    | jq -r .status)
  echo "$EXEC_ID: $STATUS"
  case $STATUS in
    COMPLETED|FAILED|CANCELLED) break ;;
  esac
  sleep 5
done

# 3. 拿产物列表
curl -s "https://braidrun.com/api/v1/executions/$EXEC_ID/artifacts" \
  -H "Authorization: Bearer $DYK_TOKEN" | jq .artifacts

Kế hoạch trong tương lai

• Tập tin bóng loáng OpenARI 3 — cho SIK tự động sản xuất
• Python/Node.js/ Go SDK chính thức
• Các sự kiện của máy phục vụ: get //api/v1/executions/{id}/ events real-time moction tiến trình đẩy nhanh
• Callback sự kiện webhook (gửi lại khi thực thi hoàn tất)