data-slots=image, heading, text

data-background=rgb(225, 190, 185)

data-theme=dark

Workflow Builder API (beta)

Run published workflows over many assets at scale with batch execution, progress tracking, and per-asset results.

Overview

The Workflow Builder API (Firefly Creative Production for Enterprise) lets you execute a single published workflow across multiple assets in one batch. You submit a workflow definition and your images or videos; the service processes each asset through the workflow in parallel and returns results per asset.

Use it to remove backgrounds, apply effects, or run any published workflow at scale with full control over concurrency, priority, and error handling.

What is the Workflow Builder API?

The Workflow Builder API allows you to:

• Integrate systems — Connect the Workflow Builder API with external platforms to trigger workflow executions directly from those environments. This enables automated creative production or modification of assets using content that already exists in those systems, with processed outputs returned back to the originating environment for seamless end-to-end workflows.
• Execute batches — Start a batch job with a workflow ID and full workflow definition (actions and connections); include all images in the workflow's input-images action and receive a batch ID to track progress.
• List and filter batches — View your batches, filtered by status, workflow ID, or creation date, with pagination.
• Monitor progress — Get batch status with asset counts (total, completed, failed, pending, processing), execution statistics, and estimated time remaining.
• Cancel when needed — Cancel a pending or running batch so no new assets are started; in-flight work may complete.
• Retrieve results — List individual execution results per asset, including outputs for successes and error messages for failures, with optional filtering and pagination.

Why choose Workflow Builder?

• Scale without rewriting — Run the same published workflow you use for single assets across dozens or hundreds of assets in one request.
• Controlled parallelism — Set concurrency and priority for fair-share throttling and predictable throughput.
• Resilient runs — Continue on error by default so one failing asset does not stop the batch; use execution lists to identify and retry failures.
• Full visibility — Track progress with asset counts and timing estimates, and fetch detailed per-asset results when the batch completes.

Discover

data-slots=heading, link, text

data-slots=link, text

Ready to try it?

See the Workflow Builder feature guide for step-by-step use of the API, and Getting started for authentication and setup.