# Introduction

**Introduction**

The **MadConnect Embedded API** enables seamless integration with the **MadConnect platform**, providing a standardized and efficient way to configure connectors, establish connections, manage accounts, and retrieve reports. Designed for flexibility and scalability, this API allows client applications to embed powerful data connectivity capabilities within their applications while ensuring security and reliability.

The Embedded API supports the following key functionalities:

* **Authentication** – Secure access using the **OAuth client credentials flow**, where client applications obtain an access token from MadConnect.
* **Account Management** - **Create and manage accounts** under an organization, enabling structured access to resources.
* **Connector Management** – Configure and authenticate connectors using **API key-based** or **OAuth-based** mechanisms.
* **Connection Management** – Create and manage **connections**, which serve as scalable **data pipelines** between source and destination connectors.
* **Data Transfers** – Initiate and monitor data transfers over active connections.
* **Reporting** – Retrieve **account-level and connection-level reports** for insights into usage and data flow.

This document serves as the **technical specification** for the **MadConnect Embedded API** and includes:

* **API endpoints** and their functionalities.
* **Request and response formats**, including supported HTTP methods and payload structures.
* **Authentication mechanisms** for secure API access.
* **Error handling and response codes** for consistent API interactions.
* **Retrieve reports** at both the account level and connection level to gain insights into usage and data transfers.

The below diagram shows a typical client application interaction using the MadConnect Embedded API.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcg2Lo50JyVQm-8FWCkEhYi_FIEO-5uc-vZxGlfdEDtakt66KwkHxtxGNqCoTpEHGncDCgHeych125-J7xxz-0_E0o9idCzDM6vqOhHlnQ5scpTiBpwllCXgHWLEX_W0_44dnA?key=CZLus8ey0VaxIeB0Ry3nvHzI" alt=""><figcaption></figcaption></figure>


---

# 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.madconnect.ai/deployment-options/madconnect-apis/introduction.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.
