Workflows orchestrate one or more functions into a directed acyclic graph (DAG) for document processing.Use these endpoints to create, update, list, and manage workflows, and to invoke themwith file input via `POST /v3/workflows/{workflowName}/call`.The call endpoint accepts files as either multipart form data or JSON with base64-encodedcontent. In the Bem CLI, use `@path/to/file` inside JSON values to automatically read andencode files:```bem workflows call --workflow-name my-workflow \ --input.single-file '{"inputContent": "@file.pdf", "inputType": "pdf"}' \ --wait```
Bem Workflows API is one of 22 APIs that Bem 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
9 operations
across 6 paths,
and defines 62 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.bem.ai, https://api.eu1.bem.ai.
9 operations6 paths62 schemas1 DELETE4 GET1 PATCH3 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.bem.ai
Authentication
API Key
Resource Areas
1
Authentication & Security 1
Bem Workflows API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as x-api-key (API Key).
By default, every request must be authenticated.
API Key — Authenticate using API Key in request header
Paths & Operations 9
Across 6 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Workflows 9
Workflows orchestrate one or more functions into a directed acyclic graph (DAG) for document processing. Use these endpoints to create, update, list, and manage workflows, and to…
The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are TransformEvent (32 properties), ExtractEvent (27 properties), ParseEvent (27 properties), AnalyzeEvent (22 properties). Each schema is shown below with its type and property counts.
WorkflowV3CreateResponse
object
3 properties
FunctionCallCreateInput
object
Input file(s) for a call. Provide exactly one of singleFile or batchFiles. In the CLI, use the nested flags --input.single-file or --input.batch-files with @pa…
2 properties
FunctionCallCreateInputResponse
object
2 properties
PayloadShapingEvent
object
Emitted by payloadshaping functions, which restructure JSON payloads using JMESPath expressions configured on the function. The shaped result is carried in tra…
16 properties5 required
SendEvent
object
21 properties6 required
AnyType
AnalyzeEvent
object
Emitted by functions of the legacy analyze type (the vision path predecessor of extract). Carries the extracted JSON along with per-field bounding-box metadata…
22 properties6 required
SplitItemEvent
object
18 properties5 required
ParagonConnectorRequestConfig
object
Request-side config block for a Paragon connector. Fields absent on update are unchanged.
2 properties
WorkflowCallMultipartFormData
object
5 properties
CopiedFunctionInfo
object
6 properties6 required
SendEventS3Output
object
Metadata returned when a Send function delivers to an S3 bucket.
2 properties2 required
WorkflowV3
object
V3 read representation of a workflow version.
13 properties9 required
WorkflowNodeResponse
object
Read representation of a call-site node.
3 properties2 required
CallV3
object
A workflow call returned by the V3 API. Compared to the V2 Call model: - Terminal outputs are split into outputs (non-error events) and errors (error events) -…
13 properties6 required
CallGetResponseV3
object
2 properties
EventInboundEmail
object
4 properties3 required
JoinEventItem
object
4 properties3 required
ListWorkflowVersionsResponseV3
object
3 properties
WorkflowCreateRequestV3
object
7 properties3 required
WorkflowConnector
object
A connector attached to a workflow. Ingestion point that triggers the workflow.
4 properties3 required
JoinEvent
object
22 properties8 required
WorkflowCopyRequest
object
6 properties2 required
ParseEvent
object
Emitted when a parse function completes. Reuses the extract event shape on the wire — both wrap a Transformation and downstream consumers care about the same t…
27 properties7 required
EvaluationEvent
object
Emitted when a function-accuracy evaluation completes for a transformation. Evaluations are scheduled by POST /v3/eval and run asynchronously; this event repor…
20 properties8 required
FunctionVersionIdentifier
object
3 properties
collectionProcessingEvent
object
14 properties7 required
WorkflowsListResponseV3
object
3 properties
TransformEvent
object
32 properties7 required
WorkflowEdgeRequest
object
A directed edge between two named call-site nodes.
4 properties2 required
ParagonConnectorConfig
object
Paragon-integration configuration on a workflow connector.
3 properties3 required
SendDestinationType
string
Destination type for a Send function.
WorkflowCallJsonBody
object
JSON request body for POST /v3/workflows/{workflowName}/call.
4 properties1 required
WorkflowConnectorError
object
Per-connector failure surfaced alongside a successful workflow DAG save.
5 properties3 required
SingleFileInputResponse
object
2 properties
EventV3
object
V3 read-side event union. Superset of the shared Event union: it contains every shared variant verbatim (backward compatible) and adds the V3-only extract, par…
WorkflowConnectorType
string
Discriminator for a workflow connector. V3 supports paragon only.
GetWorkflowVersionResponseV3
object
2 properties
BatchFilesInputItemResponse
object
3 properties
SendEventGoogleDriveOutput
object
Metadata returned when a Send function delivers to Google Drive.
2 properties2 required
WorkflowNodeRequest
object
A single function call-site node in a workflow DAG.
3 properties1 required
EnrichEvent
object
16 properties5 required
ClassifyEvent
object
17 properties5 required
UserActionSummary
object
6 properties2 required
SendEventWebhookOutput
object
Metadata returned when a Send function delivers to a webhook.
2 properties2 required
WorkflowAudit
object
3 properties
SendDeliveryStatus
string
Outcome of a Send function's delivery attempt.
WorkflowV3UpdateResponse
object
3 properties
InputType
string
The input type of the content you're sending for transformation.
WorkflowConnectorRequest
object
Create/update entry for a connector inline with the workflow.
4 properties2 required
ErrorEvent
object
17 properties5 required
WorkflowEdgeResponse
object
Read representation of a directed edge between call-site nodes.
4 properties2 required
SplitCollectionEvent
object
18 properties7 required
FileInput
object
A single file input with base64-encoded content. When using the Bem CLI, use @path/to/file in the inputContent field to automatically read and base64-encode th…
2 properties2 required
RenderEvent
object
18 properties7 required
ExtractEvent
object
V3 event variants that do not exist in the shared Event union. ExtractEvent and ClassifyEvent are emitted only by V3-era function types (extract and classify).…
27 properties7 required
BatchFilesInputResponse
object
1 property
WorkflowUpdateRequestV3
object
7 properties
WorkflowCopyResponseV3
object
4 properties
BatchFilesInput
object
1 property
RouteEvent
object
17 properties5 required
WorkflowV3GetResponse
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Bem 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.