# 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.

<figure><img src="https://4187494610-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFe4cpY1jy0FJ4kgC7wSx%2Fuploads%2FCwDdKkBO3U2bZ2czfY9B%2Fapi-call-node.png?alt=media&#x26;token=4066ec9f-9199-48d1-92f5-d9adc61abe7b" alt=""><figcaption></figcaption></figure>

## Parameters

<table><thead><tr><th width="141">Setting</th><th>Description</th></tr></thead><tbody><tr><td>API</td><td>The customer specific API and method to invoke.</td></tr><tr><td>Request variables</td><td><p>Parameters needed for execution of the API. The name of the field indicates what request variable is expected, e.g. <strong>pinCode</strong>. </p><p></p><p>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. </p><p></p><p><em>The pin code needs to be retrieved earlier in the flow and stored in a variable e.g. <strong>pin</strong>= <strong>1234</strong>.</em></p></td></tr><tr><td>Request output prefix</td><td><p>API Response Handling: </p><p>When receiving output from the API, prefix the result to ensure its uniqueness within the session context. For example, using the prefix <code>booking</code> results in the variables <code>booking_result</code> (for LLM usage) and <code>booking_json</code> (for the raw JSON output).</p></td></tr></tbody></table>

Learn how the API-Call node works with the [weather flow with Open Meteo](https://docs.ixhello.com/ixhc2/general/tutorials/weather-flow-with-open-meteo-api) tutorial.&#x20;