API-Call
An API call node invokes a configured API via the integration Service. It allows the flow to share small data packets with other products. Each API has a specific configuration which becomes available after selection.
On a successful invocation of the API the flow will continue through the success exit. The flow continues through the failure exit when the API invocation fails for any technical reasons.
Parameters
API
The customer specific API and method to invoke.
Request variables
Parameters needed for execution of the API. The name of the field indicates what request variable is expected, e.g. pinCode.
The input field expects variable names, not hardcoded values, and will resolve these during the execution. If the variable name does not exist, or doesn't contain a value the execution will fail.
The pin code needs to be retrieved earlier in the flow and stored in a variable e.g. pin= 1234.
Request output prefix
API Response Handling:
When receiving output from the API, prefix the result to ensure its uniqueness within the session context. For example, using the prefix booking results in the variables booking_result (for LLM usage) and booking_json (for the raw JSON output).
Learn how the API-Call node works with the weather flow with Open Meteo tutorial.
Last updated
Was this helpful?