How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

B3 Workflows API

The Workflows API from B3 — 22 operation(s) for workflows.

B3 Workflows API is one of 39 APIs that B3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 27 operations across 22 paths, and defines 73 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://api.b3os.org/v1.

27 operations 22 paths 73 schemas 4 DELETE11 GET1 PATCH10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.b3os.org/v1
Resource Areas
1

Paths & Operations 27

Across 22 paths, the API surfaces 27 operations — 4 DELETE, 11 GET, 1 PATCH, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workflows 27
GET
/v1/workflows
Get all workflows
2 params → 200
POST
/v1/workflows
Create a new workflow
body → 200400
POST
/v1/workflows/validate
Validate a workflow definition without saving
body → 200400
DELETE
/v1/workflows/{id}
Archive a workflow (soft delete)
1 param body → 200404
GET
/v1/workflows/{id}
Get a workflow by ID
1 param → 200404
PUT
/v1/workflows/{id}
Update a workflow (creates new version due to immutability)
1 param body → 200400404
DELETE
/v1/workflows/{id}/draft
Discard the draft version of a workflow
1 param → 200404
GET
/v1/workflows/{id}/draft
Get the draft version of a workflow
1 param → 200404
GET
/v1/workflows/{id}/live
Get the live (active/paused) version of a workflow
1 param → 200404
POST
/v1/workflows/{id}/pause
Pause a workflow
1 param body → 200400404
POST
/v1/workflows/{id}/publish
Publish a draft workflow (validates cronjob intervals, activates)
1 param body → 200400404409
POST
/v1/workflows/{id}/refill
Refill remaining runs for a workflow
1 param body → 200400404
POST
/v1/workflows/{id}/regenerate-descriptions
Regenerate AI descriptions for a workflow
1 param → 200404500
POST
/v1/workflows/{id}/resume
Resume a paused workflow
1 param body → 200400404
POST
/v1/workflows/{id}/rollback
Rollback workflow to a previous version
1 param body → 200400404
POST
/v1/workflows/{id}/run
Run a workflow with optional payload. Works for draft and active workflows. Does not count against maxRuns or enforce cooldown.
1 param body → 200400404
GET
/v1/workflows/{id}/runs
List all runs for a specific workflow
3 params → 200404
GET
/v1/workflows/{id}/runs/count
Count runs for a specific workflow, grouped by status
1 param → 200404
DELETE
/v1/workflows/{id}/storage
Clear all storage data for a workflow
1 param body → 200404
GET
/v1/workflows/{id}/trigger-info
Get trigger info (e.g. Pipedream email address) for a workflow
1 param → 200404
PATCH
/v1/workflows/{id}/ui-metadata
Update workflow UI metadata (node positions) in-place
1 param body → 200400404409
GET
/v1/workflows/{id}/versions
List all versions of a workflow
3 params body → 200404
GET
/v1/workflows/{id}/versions/count
Count total versions for a specific workflow
1 param → 200404
GET
/v1/workflows/{id}/versions/{versionNumber}
Get a specific version of a workflow by version number
2 params → 200400404
DELETE
/v1/workflows/{id}/widget
Disable public widget for a workflow
1 param body → 200400404
POST
/v1/workflows/{id}/widget
Enable public widget for a workflow
1 param body → 200400404
GET
/v1/workflows/{id}/runs/stream
Stream workflow run events
1 param → 200400403

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Workflow (28 properties), github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Template (26 properties), WorkflowListItem (23 properties), github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Tag (12 properties). Each schema is shown below with its type and property counts.

PublishWidgetSuccessResponse
object
4 properties
RefillWorkflowData
object
2 properties
CreateWorkflowParams
object
10 properties 3 required
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ConnectorReference
object
nil if action doesn't need connector
2 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.NodePosition
object
2 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowInput
object
4 properties
ListWorkflowsSuccessResponse
object
4 properties
PublishWidgetParams
object
5 properties 1 required
RefillWorkflowSuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.CommentReply
object
5 properties
GetWorkflowSuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowNode
object
9 properties 2 required
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.SuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Comment
object
9 properties
CountWorkflowRunsSuccessResponse
object
4 properties
ValidateWorkflowParams
object
2 properties 1 required
WorkflowListItem
object
23 properties
ListRunsSuccessResponse
object
4 properties
CreateWorkflowSuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse
object
4 properties
WorkflowVersionsData
object
5 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.PropSchema
object
8 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowStatus
string
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNote
object
9 properties
UpdateWorkflowUIMetadataResponseData
object
1 property
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.RunStatus
string
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.TemplateVisibility
string
CountWorkflowVersionsSuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNoteUser
object
2 properties
ListWorkflowVersionsSuccessResponse
object
4 properties
RollbackWorkflowParams
object
2 properties 1 required
Position
object
2 properties
PublicWidgetData
object
Widget contains the public widget configuration with derived trigger values
9 properties
RunParams
object
3 properties
GetTriggerInfoSuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Template
object
26 properties
WorkflowVersionCount
object
1 property
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowUIMetadata
object
3 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowDefinition
object
Definition is the full workflow graph to execute. Must contain a "root" node with type "manual". All action nodes referenced in children arrays must be present.
3 properties 1 required
ValidationResult
object
2 properties
UpdateWorkflowParams
object
10 properties 1 required
WorkflowConnectorInfo
object
1 property
GetWorkflowVersionSuccessResponse
object
4 properties
UpdateWorkflowUIMetadataParams
object
2 properties 1 required
RunSuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowType
string
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.RunListItem
object
8 properties
WorkflowRunCount
object
5 properties
TriggerInfoResponse
object
1 property
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.TemplateProp
object
8 properties
RegenerateDescriptionsSuccessResponse
object
4 properties
data
object
1 property
RefillWorkflowParams
object
1 property 1 required
PublishWorkflowParams
object
1 property
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Workflow
object
28 properties
RunResponse
object
1 property
ValidationErrorItem
object
5 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.X402DiscoveryMetadata
object
7 properties
RegenerateDescriptionsData
object
2 properties
PaginatedData-github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity_RunListItem
object
4 properties
NodeSummary
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNoteSize
object
2 properties
ValidateWorkflowSuccessResponse
object
4 properties
RollbackWorkflowSuccessResponse
object
4 properties
UpdateWorkflowUIMetadataSuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Tag
object
12 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.X402Config
object
8 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.PublicWidgetConfig
object
6 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.X402DiscoverySchema
object
2 properties
PaginatedData-schemas_WorkflowListItem
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_PaginatedData-github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity_Template
object
4 properties
UpdateWorkflowSuccessResponse
object
4 properties
DefinitionSummary
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

b3-workflows-api-openapi.yml Raw ↑

Other APIs B3 publishes across the network.

B3 Action API
B3 Actions API
B3 Admin API
B3 Ai API
B3 Api Keys API
B3 Connector Types API
B3 Connectors API
B3 Contract API
B3 Contracts API
B3 CU API
B3 faucet API
B3 Integrations API
Where this information came from

This is an independent, third-party profile of B3 Workflows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.