Z-API

Z-API

Z-API WhatsApp gateway from Brazil: check the instance connection, browse chats and contacts, verify numbers on WhatsApp and send text, image and document messages through a WhatsApp number linked by QR code.

7-day free trial · No credit card · EU-hosted

Ask Z-API anything

Try a real prompt against Z-API via AnythingMCP — Claude calls the tools, returns the answer. Press Enter on your own message to install on Cloud.

Install Z-API on Cloud
Z-API · live via MCP
Share
Opus 4.7

Claude is AI and can make mistakes. Please double-check responses.

Setup in 2 minutes

  1. 1Start a free trial on cloud.anythingmcp.com.
  2. 2Click Z-API in the connector store. Paste credentials when prompted.
  3. 3Mint an MCP API key and point your AI client at the generated MCP URL.
Install Z-API now

Guides for Z-API

Step-by-step setup for the most popular AI clients.

Setting up Z-API

From the connector definition itself: where to find the credentials, what they need to be allowed to do, and which API this adapter talks to.

Z-API is a third-party WhatsApp gateway: it runs a WhatsApp Web session for a number you link yourself. It is not Meta's official WhatsApp Business API, and WhatsApp may restrict or ban numbers that send in bulk.

Getting credentials

  1. In the Z-API panel, open Instances, create or pick an instance and click edit. Copy the instance ID into ZAPI_INSTANCE_ID and the instance token into ZAPI_INSTANCE_TOKEN.
  2. Open the Security tab, module Account Security Token, click Set Up Now and copy the token into ZAPI_CLIENT_TOKEN. Then click Activate Token so every request must carry it.
  3. Link the phone first: scan the instance QR code in the panel with WhatsApp (Linked devices). Until then every send fails.

Workflow: call z_api_get_status first. connected: false means the QR code must be scanned again; smartphoneConnected: false means the phone is offline. Use z_api_list_chats or z_api_check_phone_exists to find the right recipient before sending.

Formats: phone numbers are digits only, country code + area code + number, no +, spaces or dashes: 5511999999999. Group chats use their ID from z_api_list_chats, e.g. 120363019502650977-group. Text supports *bold*, _italic_ and ~strike~. Images and documents are sent by public HTTPS URL; Z-API downloads them (files up to 100 MB).

Sending: the send tools write real WhatsApp messages. Always confirm the recipient and the exact text with the user before calling them, and never retry a send that returned a messageId. Messages go through a queue; z_api_list_queue shows what is still waiting.

Pagination and limits: chats and contacts take page and pageSize (both required by Z-API; the tools default to page 1). Ask for the next page until fewer results than pageSize come back. The queue uses the pagingState cursor until hasMore is false. Z-API sets no message cap, but WhatsApp watches the number: keep volumes modest and space sends minutes apart. Plans are billed per instance, with a 2-day free trial.

Cloud reachability: api.z-api.io is a public HTTPS API, reachable from AnythingMCP Cloud. If you enabled IP restriction in the Z-API Security tab, allow the AnythingMCP outbound address or turn the restriction off.

Your AI is two clicks away from Z-API.

Install the connector, paste your credentials, ask your AI a question. 7-day free trial, no credit card.