What are you trying to run?

Turn a WhatsApp account into an API you can build on.

Run the Easy API, link your phone, and send a first message in minutes. Then connect CRMs, AI agents, plugins, or your own Node.js app without rebuilding the WhatsApp Web runtime yourself.

Send your first message Choose your path

I already have

CLI runningNode appRemote workerMulti-session fleetAI agent

Wally the walrus typing at a retro developer desk

npx @open-wa/wa-automate --port 8080 --api-key ***

Choose your route

Pick the path that matches your task

Start with the CLI when you need an API. Use custom code when your Node.js app owns the runtime. Use SocketClient when another process should consume an existing session.

Fastest path

Run the Easy API

Start the API, authenticate WhatsApp, open the live docs, and send one test message.

Best for: I need an API today
Time: 5-10 minutes
You need: Phone login, API key, local port
Avoid if: Your Node app must own browser lifecycle and driver choice.
Wrong path symptom: Your app fights the API process for runtime ownership.
Blocked?: Check configuration, auth readiness, or the API Explorer.

CLI runtime, API key, generated docs

Open guide ->

Library mode

Embed the runtime

Use createClient in Node.js when your app must own the session lifecycle.

Best for: I already have a Node.js app
Time: Deep integration path
You need: createClient, browser driver, lifecycle handlers
Avoid if: You only need a hosted API another service can call.
Wrong path symptom: Setup stalls while you wire browser details you do not need.
Blocked?: Start with the runtime model before adding handlers.

createClient, drivers, events

Open guide ->

Remote consumer

Connect remotely

Connect a worker, dashboard, bot, or service to an Easy API session.

Best for: I already have a bot, worker, or CRM
Time: After Easy API is running
You need: Running Easy API, API key, reachable URL
Avoid if: No Easy API process owns the WhatsApp session yet.
Wrong path symptom: The consumer connects but no session is ready.
Blocked?: Verify session events and API key configuration.

SocketClient, RPC, SSE events

Open guide ->

After your first success

Use task guides before method lookup

Once the route works, move through session health, messages, integrations, multi-session operations, and recovery before using API lookup for exact method names.

Pick ownership