GET/quickstart—200OK

Send your first message in 5 minutes

// Follow these four steps to create an account, connect your WhatsApp number, and send a message via the API.

step/01-account.sh

ready

1 $wsapi register --create-account

Sign up for a free WSAPI account using your email, Google, or GitHub credentials. No credit card is required to start your 14-day trial.

step/02-instance.sh

ready

2 $wsapi instance create --pair

After registering, you'll be taken directly to the pairing page. Scan the QR code with your phone to connect your WhatsApp account. You can also access this anytime from the /dashboard.

step/03-credentials.sh

ready

3 $wsapi instance get-credentials

Copy your Instance ID from the instance detail page. Then generate your API Key in /app/settings. These two values authenticate every API request.

x-api-key: YOUR_API_KEY
x-instance-id: YOUR_INSTANCE_ID

step/04-send-message.sh

ready

4 $wsapi message send --text

Use the following cURL command to send a text message. Replace the placeholder values with your actual credentials and the recipient phone number (including country code, no + or spaces).

curl -X POST https://api.wsapi.chat/message/text \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-instance-id: YOUR_INSTANCE_ID" \
  -d '{
    "to": "1234567890",
    "text": "Hello from WSAPI!"
  }'

✓ 200 OK — Message delivered. Response includes the message ID.

$ wsapi docs --open

Want to explore more?

// The full API reference covers every endpoint, webhook event, and configuration option.