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

Dapr Workflow API

Workflow orchestration operations.

Dapr Workflow API is one of 13 APIs that Dapr publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, an AsyncAPI specification, and 9 JSON Schemas.

This API exposes 7 operations across 7 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, http://localhost:3500.

7 operations 7 paths 1 schemas 1 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
http://localhost:3500
Contact
License
Resource Areas
1

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 1 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Workflow 7

Workflow orchestration operations.

POST
/v1.0/workflows/{workflowComponentName}/{workflowName}/start
Dapr Start Workflow
startWorkflow 3 params body → 200400500
GET
/v1.0/workflows/{workflowComponentName}/{instanceId}
Dapr Get Workflow
getWorkflow 2 params → 200404500
POST
/v1.0/workflows/{workflowComponentName}/{instanceId}/terminate
Dapr Terminate Workflow
terminateWorkflow 2 params → 202404500
POST
/v1.0/workflows/{workflowComponentName}/{instanceId}/raiseEvent/{eventName}
Dapr Raise Workflow Event
raiseWorkflowEvent 3 params body → 202404500
POST
/v1.0/workflows/{workflowComponentName}/{instanceId}/pause
Dapr Pause Workflow
pauseWorkflow 2 params → 202404500
POST
/v1.0/workflows/{workflowComponentName}/{instanceId}/resume
Dapr Resume Workflow
resumeWorkflow 2 params → 202404500
POST
/v1.0/workflows/{workflowComponentName}/{instanceId}/purge
Dapr Purge Workflow
purgeWorkflow 2 params → 202404500

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is WorkflowStatus (6 properties). Each schema is shown below with its type and property counts.

WorkflowStatus
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dapr-workflow-api-openapi.yml Raw ↑

Other APIs Dapr publishes across the network.

Dapr Actors API
Dapr Bindings API
Dapr Configuration API
Dapr Cryptography API
Dapr DistributedLock API
Dapr Health API
Dapr Jobs API
Dapr Metadata API
Dapr PubSub API
Dapr Secrets API
Dapr ServiceInvocation API
Dapr State API
Where this information came from

This is an independent, third-party profile of Dapr Workflow 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.