maestro
latest
false
- Introduction
- Getting started
- Process modeling with BPMN
- Process modeling with Case Management
- Designing a persistent case entity schema
- Defining case keys (system vs. external)
- Establishing task I/O and write-back contracts
- Exit rules and early stage termination
- Modeling primary and secondary stages
- Triggering a case from Data Fabric
- Implementing stage-level personas and permissions
- Setting SLAs and automated escalation rules
- Configuring a rework loop (re-entry)
- Managing live case instances: pause, migrate, and retry
- Maestro case management component dictionary
- Process modeling with Flow
- Getting started
- Core concepts
- Node reference
- Build guides
- Best practices
- Reference
- Process implementation
- Debugging
- Simulating
- Publishing and upgrading agentic processes
- Common implementation scenarios
- Extracting and validating documents
- Process operations
- Process monitoring
- Process optimization
- Reference information
Maestro user guide
Invokes a UiPath Studio Web API workflow and returns its output.
When to use API Workflow vs HTTP Request
Use the API Workflow node when the logic you need to call is built in Studio Web and published as an API workflow — for example, structured data processing or multi-step integrations authored by your team. Use the HTTP Request node when you are calling any external Representational State Transfer (REST) endpoint outside the UiPath Platform.
Configuration
| Field | Required | Description |
|---|---|---|
| API workflow | Yes | The Studio Web API workflow to invoke. Select from the list of published API workflows in your organization. |
| Input | No | Key-value pairs mapped to the API workflow's input parameters. Supports variable references. |
| Timeout | No | Maximum time to wait for the workflow to complete. |
Output variables
| Variable | Description |
|---|---|
output | The response returned by the API workflow, according to its output schema. |
error | Error details when the call fails. Use it with error handling to branch on failures. |
Examples
Reference the API workflow's output downstream with an expression:
$vars.apiWorkflow1.output
$vars.apiWorkflow1.output
To use a single field from the output, append the field name defined by the API workflow's output schema — for example, $vars.apiWorkflow1.output.<field>.
Common issues
| Issue | Resolution |
|---|---|
| API workflow not listed in the dropdown | Ensure the workflow is published in Studio Web and you have permission to invoke it. |
| Timeout error | Increase the Timeout value or optimize the Studio Web workflow for faster execution. |
| Input type mismatch | Check that the variable types you are passing match the API workflow's declared input parameter types. |