Getting started

One key per session. After account verification: create a session, link WhatsApp, then create the key on the session page. All paths below are relative to the API base URL.

API base URL

https://whatsapi.tprotool.com/v1/whatsapp

Authentication — request header

Authorization: Bearer tp_ins_…
Content-Type: application/json

Keys start with tp_ins_ and work for their own session only. Keep the key on your server — never in browser code.

Session and key

GET /instances/{instance_id}

HTTP 200
{
  "success": true,
  "instance": {
    "instance_id": "ins_…",
    "display_name": "…",
    "control_status": "running",
    "engine_status": "WORKING",
    "linked_phone": "9665xxxxxxxx"
  },
  "request_id": "…"
}

GET  /instances/{instance_id}/api-key          → { "instance_id": "ins_…", "key_prefix": "tp_ins_…" }
POST /instances/{instance_id}/api-key/rotate   → { "api_key": "tp_ins_…", "key_prefix": "…" }

instance_id is the same ins_… shown on the session page. engine_status = WORKING means WhatsApp is connected and ready to send.

Rotating issues a new key and revokes the old one immediately — update your systems right away.