Flows

Flows are reusable API workflows made from requests.

Flow structure

A flow should represent one operational task. For example, a flow might create a user, send a welcome email, write an audit event, and fetch the final user record.

Keep flows readable by naming each step after the outcome it produces, not only the endpoint it calls.

Variables

Variables pass values between requests. Use variables when a later request needs an ID, token, status, or payload value from an earlier response.

Prefer descriptive variable names such as user_id, access_token, or order_status so executions are easier to inspect.

Branches and loops

Add branching when the next step depends on a response value. Add loops when the same request pattern must run across a list of items.

Start without branches or loops when validating a new workflow. Add control flow after the straight-line path is working.

Design tips

• Keep one flow focused on one job.
• Reuse generated requests when the OpenAPI spec owns the endpoint.
• Keep manual requests clearly named so they are easy to distinguish.
• Inspect executions before adding more control flow.