Actions10
Workflow → Run Workflow
AI-generatedSummary
Execute a fal.ai workflow by specifying its ID and optional input parameters, with the ability to wait for the workflow's completion and retrieve its result or retrieve a queued request ID immediately.
Inputs
- workflowId (required) — The fal.ai workflow to execute. Specify either by selecting from a list or by providing the workflow ID in the format 'username/workflow_name'.
- workflowParameters — Workflow-specific input parameters to supply to the workflow execution. You may add multiple parameters from the workflow's schema and set their values, including complex JSON objects.
- workflowOptions — Execution options including whether to wait for the workflow to complete before returning, how often to poll the workflow status, and the maximum wait time in seconds. Default is to wait with a 5-second poll interval and max wait of 600 seconds.
Output shape
a single JSON object representing the execution result when waiting for completion or containing the queued request ID and status URLs if not waiting
If waiting for completion, the operation polls the workflow status until it is 'COMPLETED' or fails or times out. On completion, it returns the workflow output. If 'Wait for Completion' is false, it returns immediately with the queued request ID and URLs to check status, result, or cancel the request. Errors during execution return detailed error information.