Skip to main content
The Z-API MCP server can be connected to any MCP-compatible AI application (Claude, ChatGPT, custom agents, among others). The process is always similar: add the server as a connector/custom tool and authorize access to your instance. Below we show the step-by-step using Claude as an example, since it’s one of the most widely used AI apps — but the logic is the same in any MCP client.

1. Open Connector settings

In Claude, go to Settings → Connectors. Click the Add menu in the top right corner, and select Add custom connector.
Claude's Connectors screen with the Add menu open, showing the options Browse connectors and Add custom connector

2. Fill in the server name and URL

In the Add custom connector window, enter:
  • Name: whatever name you prefer — we use Z-API here just as a suggestion, to make it easier to identify later
  • MCP server URL: https://mcp.z-api.io/mcp
Claude's Add custom connector form filled in with the name Z-API and the URL https://mcp.z-api.io/mcp
Click Add. The Z-API connector will appear in the connectors list, still shown as not connected. Open the Z-API connector in the list and click Connect.
Z-API connector page in Claude showing the Connect button before connecting
This opens a browser tab to authorize the connection. You need to be logged in to the Z-API platform to proceed — if you aren’t, you’ll be prompted to log in before the instance list is shown. Choose which instance of your Z-API account you want to authorize. Find the desired instance in the list (you can use the search bar) and click Select.
Which instance would you like to connect to Claude screen, with a list of Z-API instances and a Select button on each row
If the selected instance is disconnected from WhatsApp (QR Code not scanned), linking the MCP connector won’t connect WhatsApp automatically. You’ll still need to go to the Z-API dashboard and scan the QR Code the usual way to bring the instance online.
After selecting the instance, confirm by clicking Open Claude (or Open desktop app, if you’re using the desktop app) to automatically return to Claude.
Connected confirmation screen, indicating that Claude will automatically open back up

4. Ready to use

Once the instance is selected, the connection is established automatically, making all MCP-compatible Z-API endpoints available — such as sending text, image, and video messages, group management, and other currently supported features — for direct use by Claude. To use the connector in a conversation, click the + icon next to the message field, go to Connectors, and turn on the Z-API toggle.
Claude's connectors menu in the message field with the Z-API toggle turned on
Done! The AI is now connected to your Z-API instance. Just ask it, in natural language, to send a message, an image, create a group, or perform any of the available actions — it will identify the right tool and make the request for you.
Once connected, the AI app will show up under the Connected Apps tab, inside your instance’s dashboard on Z-API. That’s where you can check when it was connected, its last use, and remove access whenever you want.

Authentication

The connection is made via OAuth, linking the chosen Z-API instance directly to the connector in your AI app. The AI never accesses your WhatsApp password or credentials directly — only the authorized endpoints of the selected instance.
Disconnecting WhatsApp from the instance (scanning the QR Code again) does not automatically revoke the AI app’s access. The two connections are independent.To revoke the AI’s access, go to the Connected Apps tab in your Z-API instance dashboard and remove the app from there — this ends access immediately, with no need to change anything in the AI app’s settings.

Frequently asked questions

No. These are two independent connections. Disconnecting WhatsApp from the instance doesn’t remove the AI app or revoke its authorization — access stays active until you remove it manually from the Connected Apps tab in the instance dashboard.
Go to your instance’s dashboard on Z-API, open the Connected Apps tab, and remove the app from there. This ends access immediately, without affecting the WhatsApp connection.
(1) Is the Z-API connector enabled for this conversation? (2) Is the selected instance connected and active in the Z-API dashboard? (3) Has the link/token expired? If so, unlink and reconnect the connector in the AI app’s settings. If the issue persists, contact technical support.
No. Once added and linked, the connector remains available to be enabled in any new conversation through the connectors menu.