Workflow Design

Orchestrate APIs.
Visually.

Arazzo-based Workflow Design with automatic visualization. Plan, document, and visualize multi-API workflows.

app.api-portal.io/workflows/pet-store
Docs Workflows Flow Diagram
sequenceDiagram — createPetAndApplyCoupon
Client
petStoreApi
couponApi
POST /pets
201 Created
POST /coupons
200 OK
Arazzo v1.0
OpenAPI Initiative
Workflow Standard
Mermaid
Diagrams
auto-generated
Retry & Error
Handling
built-in
Multi-API
Orchestration
across API boundaries

// Features

What Workflow Design delivers.

Visual Flow Designer

Automatic sequence diagrams and timeline views from your Arazzo spec. Understand complex flows at a glance.

Step-by-Step Orchestration

Define steps with actions, success criteria, and parameters. Every step clearly documented and validated.

Multi-API Workflows

Orchestrate multiple APIs in a single workflow. Source descriptions and cross-API dependencies resolved automatically.

// Workflow Explorer

5 perspectives. One workflow.

The Workflow Explorer offers five tabs to fully understand every Arazzo workflow. From the overview to the API reference — each perspective shows exactly the details you need.

  • Docs tab for overview and description
  • Workflows tab with steps and actions
  • Flow tab for sequential view
  • Diagram tab with Mermaid visualization
  • Sources tab for API references
app.api-portal.io/workflows/pet-store
Docs Workflows Flow Diagram Sources
create-pet POST createPet
$statusCode == 201 goto: apply-coupon
apply-coupon POST applyCoupon
$statusCode == 200 end
handle-error onFailure logError
retryAfter: 1s retryLimit: 3
Mermaid Sequence

sequenceDiagram

  Workflow->>petStoreApi: POST createPet()

  petStoreApi-->>Workflow: 201 Created

  Workflow->>couponApi: POST applyCoupon()

  couponApi-->>Workflow: 200 OK

  Note over Workflow: onFailure: retry (3x)

// Sequence Diagrams

Auto-generated. Instantly clear.

Mermaid.js v11 auto-generates sequence diagrams from the Arazzo spec. Every step is visualized as an interaction, with support for retry, goto, and end actions.

  • Auto-generated from Arazzo
  • Support for retry, goto, and end
  • Sequence and timeline views
  • Export as SVG or PNG

// Actions & Criteria

Retry. Goto. End. Full control.

Request
Validate
Retry?
Next Step
retry
retryLimit: 3
retryAfter: "1s"

Automatic retry on transient failures. Configurable limits and wait times.

goto
stepId: "apply-coupon"
workflowId: "checkout"

Jump to another step or workflow. Conditional branching for complex flows.

end
criteria: "$statusCode == 201"

End the workflow on success. Define precise success criteria for every step.

“With the Workflow Designer, we can finally plan and document complex API integrations visually. It saves us weeks of coordination.”
80% faster API integration

// Explore more

Related Features.

Ready for visual API orchestration?

Experience the platform for modern API management.