Skip to main content
DocsAPI Open PlatformOverview
Open platform · Getting started

API Open Platform Overview

For developers: What is an open platform, 5 minutes to get started, open scope, version commitment.

The Braidrun Workflow open platform allows external systems to drive workflow through a stable REST API: trigger execution, read results, push approval decisions, and download products. All public interfaces are authenticated by API Key - the same mechanism covers webhooks, approval callbacks and open platform v1 endpoints.

Who Should Use

  • Developers who need to trigger workflows in CI/CD, internal business systems, and mobile app services
  • Operation scenario of completing approval by clicking a link from Slack/Telegram/email
  • A team that provides Workflow-as-a-Service to partners
  • Data teams who need to flow execution results back to the enterprise data warehouse/BI system

Overall Architecture

text
┌──────────────────┐    Authorization: Bearer dyk_xxx     ┌──────────────────────┐
│   你的客户端     │ ───────────────────────────────────▶ │  Braidrun Workflow    │
│                  │                                       │   开放平台 v1 / Webhook │
│  - SDK / curl    │ ◀─── 200 OK + JSON ──────────────── │                      │
│  - CI/CD         │ ◀─── 429 + Retry-After ──────────── │  - 校验 scope        │
│  - 邮件链接      │ ◀─── 401 Unauthorized ───────────── │  - 速率限制          │
└──────────────────┘                                       │  - 累计用量          │
                                                            └──────────────────────┘

A complete open platform call: the client holds a Token in the form of dyk_<id>_<secret>, and carries a Bearer Header with each request; the server automatically accumulates usage after verifying the scope; when the upper limit of the package rate is exceeded, HTTP 429 + Retry-After is returned.

GET Started In 5 Minutes

  1. Log in Braidrun console → Enter "Account Settings → API Key"
  2. Create API Key Click "New API Key" → select the required scope (it is recommended to select WORKFLOW_READ + WORKFLOW_EXECUTE first) → set the validity period
  3. Copy Token After successful generation, a one-time display of Token will pop up. Copy and save it to your key management tool immediately.
  4. Call an endpoint test Use curl to pull your own workflow list:
bash
curl https://braidrun.com/api/v1/workflows \
  -H "Authorization: Bearer dyk_<id>_<secret>"

Open Range

DomainRange
Webhook TriggerExternal system → POST triggers bound workflow execution
Approval WebhookOne-click approval/rejection from Mail/Slack/Telegram manual_approval steps
workflow v1List/read workflow definitions; initiate execution via API
Execute v1Query execution status/read results/cancel execution
Approvals v1List pending approvals, read approval details, approve (optionally with edited approval-form data), and reject manual_approval steps
Product v1List execution products/get product download links
Version Commitment

v1 is a stable API surface: fields will not be destructively deleted, and new fields can be added. Breaking changes will be released with a new v2 path prefix and provide a minimum 6-month v1 → v2 coexistence period.