> ## Documentation Index
> Fetch the complete documentation index at: https://docs.maia.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom connectors

export const Customconnectors = () => <>the <strong>Custom Connectors</strong> icon <span style={{
  whiteSpace: "nowrap"
}}><img src="/images/global-nav/custom-connectors.png" width="20" height="20" style={{
  verticalAlign: "text-bottom",
  display: "inline",
  margin: "0 1px"
}} /></span></>;

export const maia = "Maia";

You can use Maia to create a custom connector for any API that has a publicly viewable documentation page. For best results, the documentation should be a static HTML page that clearly lists the available endpoints, methods, and parameters.

When you provide a link to the documentation, Maia reads the content of that page as well as any directly linked sub-pages under the same path. For example, if you provide a link such as `https://api.com/docs`, Maia will also access related pages like `https://api.com/docs/endpoints`, but it won't follow links outside that documentation path (such as `https://api.com/blog` or `https://api.com/other`).

As an alternative to providing a link, you can upload the file directly to Maia to create a custom connector. When uploading the file, note that there is a **5 MB limit**.

Supported file types:

* PDF
* YAML
* JSON

<Warning>
  Processing large API specifications with many endpoints may cause a timeout after 10 minutes.
</Warning>

Maia also detects whether the API requires authentication. If authentication is required, Maia prompts you to choose the appropriate method (such as API Key, Basic Auth, Bearer Token, or OAuth) and to enter the required credentials.

***

## Video example

<iframe width="560" height="315" src="https://www.youtube.com/embed/g2B7N3uQ_CI?si=3lNOZ1LJ48GmjW6z&enablejsapi=1" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share; fullscreen" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen />

***

## How to create a custom connector with Maia

This how-to guide show the steps to create a custom connector using Maia in {maia}. The process is straightforward and requires no coding skills. The API used in this example is a Matillion GreenWave API, which requires an API Key for authentication.

1. Log in to [{maia}](https://app.matillion.com/hub/).

2. In the left navigation, click <Customconnectors /> and then click **Custom Connectors**.

3. Copy and paste the URL of the documentation for the API you want to connect to into the Maia URL input field, beneath the **Add a custom connector with Maia** message. Or, you can also **upload the PDF, JSON, or YAML file**.

4. Click **Build**. Maia will begin scanning the documentation or your uploaded file.

   <img src="https://mintcdn.com/matillion/0bH-WuwTaSy4zifJ/images/create-a-custom-connector-with-maia/create-a-custom-connector-with-maia-06.png?fit=max&auto=format&n=0bH-WuwTaSy4zifJ&q=85&s=f36fa106cccaa47940846f91a4585170" alt="Create a custom connector with Maia" width="1236" height="496" data-path="images/create-a-custom-connector-with-maia/create-a-custom-connector-with-maia-06.png" />

5. If Maia detects API endpoints that can be imported, it will prompt you to choose which endpoints to include in your custom connector. Select the checkboxes next to the endpoints you want to include, and then click **Import**.

   1. Select the top-most checkbox to select all endpoints.

   <img src="https://mintcdn.com/matillion/0bH-WuwTaSy4zifJ/images/create-a-custom-connector-with-maia/create-a-custom-connector-with-maia-02.png?fit=max&auto=format&n=0bH-WuwTaSy4zifJ&q=85&s=c6299e101ef416e334f8f57c08afa293" alt="Choose endpoints to import" width="584" height="396" data-path="images/create-a-custom-connector-with-maia/create-a-custom-connector-with-maia-02.png" />

6. Select your authentication method and enter the required credentials. If the API does not require authentication, select **No Auth**.

7. Click **Send**.

   <Note>
     Your authentication credentials are used only for test requests and are not saved in the connector.
   </Note>

   <img src="https://mintcdn.com/matillion/0bH-WuwTaSy4zifJ/images/create-a-custom-connector-with-maia/create-a-custom-connector-with-maia-03.png?fit=max&auto=format&n=0bH-WuwTaSy4zifJ&q=85&s=2850c233448bd05b057a34cf8b1d704e" alt="Authentication" width="558" height="544" data-path="images/create-a-custom-connector-with-maia/create-a-custom-connector-with-maia-03.png" />

8. Maia will complete the following tasks:
   1. Import the selected endpoints.
   2. Apply authentication to the selected endpoints.
   3. Apply pagination configuration to List endpoints.
   4. Populate any required parameters.
   5. Send test requests.

9. Once Maia has completed these tasks, the Custom Connector workbench will open, displaying the imported endpoints and their details. You can review and edit the endpoints as needed.

   <Note>
     Remember to refer to the third-party API documentation for details about the endpoints and their parameters.
   </Note>

   <img src="https://mintcdn.com/matillion/0bH-WuwTaSy4zifJ/images/create-a-custom-connector-with-maia/create-a-custom-connector-with-maia-04.png?fit=max&auto=format&n=0bH-WuwTaSy4zifJ&q=85&s=85f25991c0eb2868b7c5a5422af0bd40" alt="Custom Connector workbench" width="1638" height="626" data-path="images/create-a-custom-connector-with-maia/create-a-custom-connector-with-maia-04.png" />

10. Click **Save** to save your custom connector. If you need to make changes to the connector after saving, you can reopen it from the Custom Connectors list and edit it as needed.

<img src="https://mintcdn.com/matillion/0bH-WuwTaSy4zifJ/images/create-a-custom-connector-with-maia/create-a-custom-connector-with-maia-05.png?fit=max&auto=format&n=0bH-WuwTaSy4zifJ&q=85&s=2e24fe69294a64a5fbf461047a2f8e10" alt="Save custom connector" width="1082" height="94" data-path="images/create-a-custom-connector-with-maia/create-a-custom-connector-with-maia-05.png" />
