Official generated SDKs for the Braidrun Workflow platform. This repository provides typed clients for the public workflow, execution, artifact, approval, and webhook APIs.
The clients are generated from Braidrun's OpenAPI 1.0 specification with OpenAPI
Generator 7.23.0. Unless noted otherwise in a language-specific README, the default
API base URL is https://braidrun.com.
| Language / client | Documentation |
|---|---|
| C# | csharp/README.md |
| Dart | dart/README.md |
| Go | go/README.md |
| Java | java/README.md |
| JavaScript | javascript/README.md |
| Kotlin | kotlin/README.md |
| PHP | php/README.md |
| Python | python/README.md |
| Ruby | ruby/README.md |
| Rust | rust/README.md |
| Swift 5 | swift5/README.md |
| TypeScript (Fetch) | typescript/README.md |
| TypeScript (Axios) | typescript-axios/README.md |
- Obtain an Open Platform API key from Braidrun.
- Choose an SDK from the table above.
- Follow its README for installation, configuration, endpoint documentation, and examples.
- Configure the client with the API key and, if necessary, override the default server URL.
These SDKs are currently distributed as source in this repository. Availability in language-specific package registries may vary.
Braidrun API keys have the form dyk_<id>_<secret> and are scoped to specific
operations. Prefer either Bearer authentication or the X-API-Key header:
| Method | Request value |
|---|---|
| Bearer | Authorization: Bearer dyk_<id>_<secret> |
| Header | X-API-Key: dyk_<id>_<secret> |
| Query string | ?api_key=dyk_<id>_<secret> (last resort) |
Never commit a real API key. Load credentials from environment variables or a secret manager supported by your application.
| Scope | Capability |
|---|---|
WORKFLOW_READ |
List and read workflow definitions |
WORKFLOW_EXECUTE |
Start workflow executions |
EXECUTION_READ |
Read execution status, history, and results |
EXECUTION_CANCEL |
Cancel running executions |
ARTIFACT_READ |
Read execution artifact metadata |
APPROVAL_RESPOND |
Read and decide manual approval steps |
WEBHOOK_TRIGGER |
Invoke workflows through webhook triggers |
Webhook management endpoints under /api/webhooks use the interactive browser
session or an admin service-account key instead of narrowly scoped Open Platform
keys.
The generated clients cover:
- Workflow discovery and execution
- Execution status, results, and cancellation
- Execution artifacts
- Manual approvals
- Webhook registration, statistics, and triggering
Each SDK includes endpoint and model documentation generated for that language.
The API can respond with 429 Too Many Requests. Clients should honor Retry-After
and may also inspect the X-RateLimit-Limit and X-RateLimit-Window response
headers.
Each top-level language directory is a standalone generated client with its own
package metadata, tests, and documentation. generate-sdks.sh contains the generation
workflow, and openapi-generator-cli.jar is the bundled generator used to reproduce
the clients from the Braidrun OpenAPI specification.
Generated files should normally be updated by regenerating all clients from the same API specification so that models and endpoints remain consistent across languages.