Dapr

Dapr Workflow API

Workflow orchestration operations.

GitHub OpenAPI

Operations 7

POST /v1.0/workflows/{workflowComponentName}/{workflowName}/start Dapr Start Workflow #
GET /v1.0/workflows/{workflowComponentName}/{instanceId} Dapr Get Workflow #
POST /v1.0/workflows/{workflowComponentName}/{instanceId}/terminate Dapr Terminate Workflow #
POST /v1.0/workflows/{workflowComponentName}/{instanceId}/raiseEvent/{eventName} Dapr Raise Workflow Event #
POST /v1.0/workflows/{workflowComponentName}/{instanceId}/pause Dapr Pause Workflow #
POST /v1.0/workflows/{workflowComponentName}/{instanceId}/resume Dapr Resume Workflow #
POST /v1.0/workflows/{workflowComponentName}/{instanceId}/purge Dapr Purge Workflow #

Documentation

📖
Documentation
https://docs.dapr.io/reference/api/state_api/
📖
Documentation
https://docs.dapr.io/reference/api/pubsub_api/
📖
Documentation
https://docs.dapr.io/reference/api/service_invocation_api/
📖
Documentation
https://docs.dapr.io/reference/api/bindings_api/
📖
Documentation
https://docs.dapr.io/reference/api/secrets_api/
📖
Documentation
https://docs.dapr.io/reference/api/actors_api/
📖
Documentation
https://docs.dapr.io/reference/api/workflow_api/
📖
Documentation
https://docs.dapr.io/reference/api/configuration_api/
📖
Documentation
https://docs.dapr.io/reference/api/distributed_lock_api/
📖
Documentation
https://docs.dapr.io/reference/api/cryptography_api/
📖
Documentation
https://docs.dapr.io/reference/api/jobs_api/
📖
Documentation
https://docs.dapr.io/reference/api/health_api/
📖
Documentation
https://docs.dapr.io/reference/api/metadata_api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/openapi/dapr-workflow-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/asyncapi/dapr-pubsub-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/state-item.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/cloud-event.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/binding.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/secret.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/actor.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/workflow.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/configuration-item.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/job.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/metadata.json

Other Resources

🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/state-management/
🔗
Client Libraries
https://docs.dapr.io/sdks/
🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/pubsub/
🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/service-invocation/
🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/bindings/
🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/secrets/
🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/actors/
🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/workflow/
🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/configuration/
🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/distributed-lock/
🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/cryptography/
🔗
Reference
https://docs.dapr.io/developing-applications/building-blocks/jobs/
🔗
Reference
https://docs.dapr.io/operations/observability/healthchecks/
🔗
Reference
https://docs.dapr.io/operations/observability/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/dapr-workflow-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dapr-workflow-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Dapr Actors Workflow API
  description: The Dapr Actors API provides virtual actor capabilities for distributed applications, including actor method invocation, state management, timers, and reminders. Actors provide a single-threaded programming model with guaranteed message ordering.
  version: 1.0.0
  contact:
    name: Dapr
    url: https://dapr.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:3500
  description: Dapr Sidecar
tags:
- name: Workflow
  description: Workflow orchestration operations.
paths:
  /v1.0/workflows/{workflowComponentName}/{workflowName}/start:
    post:
      summary: Dapr Start Workflow
      description: Starts a new workflow instance with the specified workflow name.
      operationId: startWorkflow
      tags:
      - Workflow
      parameters:
      - name: workflowComponentName
        in: path
        required: true
        description: The workflow component name (e.g., dapr).
        schema:
          type: string
      - name: workflowName
        in: path
        required: true
        description: The name of the workflow to start.
        schema:
          type: string
      - name: instanceID
        in: query
        description: Optional instance ID for the workflow. If not provided, a random ID is generated.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              description: Input data for the workflow.
      responses:
        '200':
          description: Workflow started successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  instanceID:
                    type: string
                    description: The unique ID of the workflow instance.
        '400':
          description: Bad request.
        '500':
          description: Failed to start workflow.
  /v1.0/workflows/{workflowComponentName}/{instanceId}:
    get:
      summary: Dapr Get Workflow
      description: Retrieves the status and details of a workflow instance.
      operationId: getWorkflow
      tags:
      - Workflow
      parameters:
      - name: workflowComponentName
        in: path
        required: true
        description: The workflow component name.
        schema:
          type: string
      - name: instanceId
        in: path
        required: true
        description: The workflow instance ID.
        schema:
          type: string
      responses:
        '200':
          description: Workflow details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowStatus'
        '404':
          description: Workflow instance not found.
        '500':
          description: Failed to get workflow.
  /v1.0/workflows/{workflowComponentName}/{instanceId}/terminate:
    post:
      summary: Dapr Terminate Workflow
      description: Terminates a running workflow instance.
      operationId: terminateWorkflow
      tags:
      - Workflow
      parameters:
      - name: workflowComponentName
        in: path
        required: true
        description: The workflow component name.
        schema:
          type: string
      - name: instanceId
        in: path
        required: true
        description: The workflow instance ID.
        schema:
          type: string
      responses:
        '202':
          description: Workflow termination accepted.
        '404':
          description: Workflow instance not found.
        '500':
          description: Failed to terminate workflow.
  /v1.0/workflows/{workflowComponentName}/{instanceId}/raiseEvent/{eventName}:
    post:
      summary: Dapr Raise Workflow Event
      description: Raises an event to a running workflow instance.
      operationId: raiseWorkflowEvent
      tags:
      - Workflow
      parameters:
      - name: workflowComponentName
        in: path
        required: true
        description: The workflow component name.
        schema:
          type: string
      - name: instanceId
        in: path
        required: true
        description: The workflow instance ID.
        schema:
          type: string
      - name: eventName
        in: path
        required: true
        description: The name of the event to raise.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              description: Event data payload.
      responses:
        '202':
          description: Event raised successfully.
        '404':
          description: Workflow instance not found.
        '500':
          description: Failed to raise event.
  /v1.0/workflows/{workflowComponentName}/{instanceId}/pause:
    post:
      summary: Dapr Pause Workflow
      description: Pauses a running workflow instance.
      operationId: pauseWorkflow
      tags:
      - Workflow
      parameters:
      - name: workflowComponentName
        in: path
        required: true
        description: The workflow component name.
        schema:
          type: string
      - name: instanceId
        in: path
        required: true
        description: The workflow instance ID.
        schema:
          type: string
      responses:
        '202':
          description: Workflow paused successfully.
        '404':
          description: Workflow instance not found.
        '500':
          description: Failed to pause workflow.
  /v1.0/workflows/{workflowComponentName}/{instanceId}/resume:
    post:
      summary: Dapr Resume Workflow
      description: Resumes a paused workflow instance.
      operationId: resumeWorkflow
      tags:
      - Workflow
      parameters:
      - name: workflowComponentName
        in: path
        required: true
        description: The workflow component name.
        schema:
          type: string
      - name: instanceId
        in: path
        required: true
        description: The workflow instance ID.
        schema:
          type: string
      responses:
        '202':
          description: Workflow resumed successfully.
        '404':
          description: Workflow instance not found.
        '500':
          description: Failed to resume workflow.
  /v1.0/workflows/{workflowComponentName}/{instanceId}/purge:
    post:
      summary: Dapr Purge Workflow
      description: Permanently deletes workflow metadata from the state store, including stored inputs, outputs, and history. Only COMPLETED, FAILED, or TERMINATED workflows can be purged.
      operationId: purgeWorkflow
      tags:
      - Workflow
      parameters:
      - name: workflowComponentName
        in: path
        required: true
        description: The workflow component name.
        schema:
          type: string
      - name: instanceId
        in: path
        required: true
        description: The workflow instance ID.
        schema:
          type: string
      responses:
        '202':
          description: Workflow purged successfully.
        '404':
          description: Workflow instance not found.
        '500':
          description: Failed to purge workflow.
components:
  schemas:
    WorkflowStatus:
      type: object
      properties:
        instanceID:
          type: string
          description: The workflow instance ID.
        workflowName:
          type: string
          description: The name of the workflow.
        createdAt:
          type: string
          format: date-time
          description: When the workflow was created.
        lastUpdatedAt:
          type: string
          format: date-time
          description: When the workflow was last updated.
        runtimeStatus:
          type: string
          enum:
          - RUNNING
          - COMPLETED
          - FAILED
          - TERMINATED
          - PENDING
          - SUSPENDED
          description: The runtime status of the workflow.
        properties:
          type: object
          additionalProperties:
            type: string
          description: Additional workflow properties.
externalDocs:
  description: Dapr Actors API Reference
  url: https://docs.dapr.io/reference/api/actors_api/