> For the complete documentation index, see [llms.txt](https://docs.zingy.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zingy.ai/app-editor/page-flow/toolbox-blocks/execute-api-call.md).

# Execute API Call

{% hint style="info" %}
**Block Information**

Available in: Page Flow and Cloud Flow

Toolbox Category: Connections

Block Type: [Regular](/app-editor/page-flow/block-anatomy.md#regular-block)
{% endhint %}

The **`Execute API Call`** block is used to communicate with other apps including third-party software services.

<div align="left"><figure><img src="https://3401585094-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmnBepgycwgisXr9ya1N4%2Fuploads%2F3taXDjoqCdbOO6RwFYcO%2Fimage.png?alt=media&amp;token=158167c0-aca2-4529-aa93-aa3f94d07363" alt="" width="438"><figcaption></figcaption></figure></div>

The block consists of the following (from top to bottom)::

* *Connection Name:* [Value Parameter](/app-editor/page-flow/block-anatomy.md#value-parameters) that accepts a [*text*](/app-editor/page-flow/references/value-types.md) value representing the name of the [connection](/app-editor/connections.md) to use.
* *Data*: Optional [Value Parameter](/app-editor/page-flow/block-anatomy.md#value-parameters) that accepts an [object](/app-editor/page-flow/references/value-types.md) value representing the request data to be used for the API Call. The properties of the provided object will be combined with the [Request Data setting in the connection](/app-editor/connections/services/api-call.md#request-data).
* *Params*: Optional [Value Parameter](/app-editor/page-flow/block-anatomy.md#value-parameters) that accepts an [object](/app-editor/page-flow/references/value-types.md) value representing the request parameters to be used for the API Call. The properties of the provided object will be combined with the [Request Parameters setting in the connection](/app-editor/connections/services/api-call.md#request-parameters).
* *Success Tasks*: a [Flow Parameter](/app-editor/page-flow/block-anatomy.md#flow-parameters) where you connect blocks that specify what you want done when the operation completes successfully. The [Connection Data](/app-editor/page-flow/toolbox-blocks/connection-data.md) block can be used to access the output of the API call.
* *Fail Tasks*: a [Flow Parameter](/app-editor/page-flow/block-anatomy.md#flow-parameters) where you connect blocks that specify what you want done when the operation reports an error. The [Connection Error](/app-editor/page-flow/toolbox-blocks/connection-error.md) block can be used to access the error information.

***

## Usage Example

The image below shows an example of the **`Execute API Call`** block.

<figure><img src="https://3401585094-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmnBepgycwgisXr9ya1N4%2Fuploads%2FDTM42bHaqxWDslT9AHyq%2Fimage.png?alt=media&amp;token=e1dd798b-7a6e-4eeb-b8aa-04a052be0e7d" alt=""><figcaption><p>Example of Execute API Call block</p></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zingy.ai/app-editor/page-flow/toolbox-blocks/execute-api-call.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.