Connect Z-API to Your AI Agent

Ask your AI assistant to work with Z-API: send whatsapp messages and check instance status.

4 tools API key

Try a Z-API Task

Copy a prompt into your agent with the oo Skill installed. Add your page links and source notes before running it.

oo Skill Z-API

Send a Text Message

Check instance status before sending specified text.

/oo Z-API: Check my Z-API instance status, then send phone [contact or group identifier] message [exact text].

Send a Hosted Image

Send an image from a public URL.

/oo Z-API: Send Z-API image to phone [recipient] using imageUrl [public image URL].

Start Working with Z-API

  1. Install OOMOL

    Set up oo CLI and the oo Skill in your agent.

    Install OOMOL →
  2. Connect Z-API

    Connect with the Client Token, Instance ID, and Instance Token.

    Connect Z-API →
  3. Give Your Agent a Task

    Use /oo with the pages to read, the changes to make, and where to save the result.

    Connection Guide →

Choose Your Agent

  • An account with access to the Z-API resources used in your task.

Z-API Tools

Z-API sends text, images, and fixed locations through a configured WhatsApp instance and exposes its connection status.

Send a Text Message

Check instance status before sending specified text.

Send a Hosted Image

Send an image from a public URL.

4 tools

Get Instance Status

Check whether the Z-API instance and its connected smartphone are online.

z_api.get_instance_status

Send Text

Send a plain-text message to a WhatsApp contact or group through Z-API.

z_api.send_text

Send Image

Send an image from a public URL to a WhatsApp contact or group through Z-API.

z_api.send_image

Send Location

Send a fixed location to a WhatsApp contact or group through Z-API.

z_api.send_location

Frequently Asked Questions

Which credentials are required?

Supply the Client Token, Instance ID, and Instance Token.

Does online status prove message delivery?

Status describes the instance and smartphone connection, not delivery of a specific message.

Can I send a fixed location?

Supply phone, title, address, latitude, and longitude.

Connect Z-API

About Z-API ↗