# 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="/files/g1UyyouhhlIUjIHolgdR" 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](/ixhc2/general/tutorials/weather-flow-with-open-meteo-api.md) tutorial.&#x20;


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ixhello.com/ixhc2/flows/flow-editor/api-call.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.