# Pilot Status

> Pilot Status — WhatsApp API & messaging infrastructure. Send and receive WhatsApp messages via REST API, webhooks, MCP server, and dashboard. Official (Meta Cloud API) and unofficial connections.

## Docs

- [GET /v1/analytics/dashboard — Analytics](https://docs.pilotstatus.com.br/api/analytics.md): Retrieve dashboard KPIs and daily message series, scoped to the API key's number.
- [API Keys — List, Regenerate, Rotate](https://docs.pilotstatus.com.br/api/api-keys.md): List per-number API keys, regenerate a number's key, and rotate your own key via /v1/api-keys.
- [API Authentication with x-api-key | Pilot Status](https://docs.pilotstatus.com.br/api/authentication.md): Authenticate with the x-api-key or x-api-key-id header, ps_ key prefix, number-scoped vs tenant-scoped keys, and key rotation.
- [Connect Page Branding (White-label)](https://docs.pilotstatus.com.br/api/branding.md): Brand the public connect page per tenant — logo, colors, titles, white-label toggle — via dashboard, GET/PUT /v1/branding, per-link overrides, or URL params.
- [Calls API Reference](https://docs.pilotstatus.com.br/api/calls/endpoints.md): All /v1/calls endpoints — start, answer, reject and terminate calls, calling settings, and call permissions.
- [WhatsApp Business Calling — Overview](https://docs.pilotstatus.com.br/api/calls/overview.md): Receive and make WhatsApp voice calls through the Pilot Status API — signaling-only SDP relay, browser softphone, and Meta-side billing.
- [Check if a Number Is on WhatsApp](https://docs.pilotstatus.com.br/api/check-number.md): Check whether phone numbers are registered on WhatsApp using the connected number's session.
- [GET /v1/conversations — List Conversations](https://docs.pilotstatus.com.br/api/conversations.md): List conversations for the connected number, ordered by the most recent message activity.
- [POST /v1/embed/sessions — Embed Tokens](https://docs.pilotstatus.com.br/api/embed-sessions.md): Mint short-lived embed tokens server-to-server to embed the white-label Chat and Connect microfrontends into your own SaaS.
- [Extra Numbers & On Demand](https://docs.pilotstatus.com.br/api/extra-numbers.md): Buy extra WhatsApp numbers via /v1/subscription/extra-numbers — preview cost, Free → On Demand conversion, and payment via saved card or checkout URL.
- [WhatsApp Groups API](https://docs.pilotstatus.com.br/api/groups.md): Send to, list, create, and manage WhatsApp groups, including participants, invites, and pinned messages.
- [Labels](https://docs.pilotstatus.com.br/api/labels.md): Tag contacts and groups with tenant-scoped labels, via the dashboard or the send API.
- [Evolution GO Compatibility Layer — API Reference](https://docs.pilotstatus.com.br/api/layer/evolution-go.md): Use the Pilot Status Evolution GO API Layer to run Evolution GO-compatible requests. Replace your base URL with the Pilot Status layer endpoint to migrate.
- [Evolution V2 Compatibility Layer — API Reference](https://docs.pilotstatus.com.br/api/layer/evolution-v2.md): Migrate from Evolution API V2 to Pilot Status by pointing your base URL at the Evolution V2 layer. No code changes to request bodies or handlers required.
- [API Layer: Migrate to Pilot Status Without Code Changes](https://docs.pilotstatus.com.br/api/layer/overview.md): The Pilot Status API Layer accepts Evolution API-compatible requests. Switch providers by changing only your base URL — no code rewriting needed.
- [GET /v1/media/{mediaId} — Download Inbound Media](https://docs.pilotstatus.com.br/api/media-download.md): Download inbound media received via Meta Cloud API as base64.
- [DELETE /v1/messages/cancel — Cancel Scheduled Sends](https://docs.pilotstatus.com.br/api/messages/cancel.md): Cancel scheduling for messages still queued for a future send.
- [GET /v1/messages/group — Group Messages](https://docs.pilotstatus.com.br/api/messages/group-messages.md): Retrieve messages from GROUP conversations for the connected number.
- [GET /v1/messages/history — Message History](https://docs.pilotstatus.com.br/api/messages/history.md): Retrieve the full stored message history (direct and group conversations) for the connected number.
- [Log Error Codes](https://docs.pilotstatus.com.br/api/messages/log-error-codes.md): Closed set of errorCode values shown on failed sends in Logs and the dashboard API.
- [POST /v1/messages/send — Send a WhatsApp Message](https://docs.pilotstatus.com.br/api/messages/send.md): Send template, free-form text, or direct media WhatsApp messages through a single endpoint.
- [GET /v1/messages/{messageId} — Message Status](https://docs.pilotstatus.com.br/api/messages/status.md): Query the current delivery status of a sent WhatsApp message.
- [GET /v1/messages/unread — Unread Messages](https://docs.pilotstatus.com.br/api/messages/unread.md): Retrieve all inbound messages that have not been read yet for the connected number.
- [WhatsApp Channels (Newsletters) API](https://docs.pilotstatus.com.br/api/newsletters.md): List WhatsApp channels (newsletters) tied to the connected number.
- [POST /v1/numbers — Create a Number](https://docs.pilotstatus.com.br/api/numbers/create.md): Create a WhatsApp number via the API — QR code / pairing code for unofficial numbers, provider META flows, regenerate QR, and delete.
- [GET /v1/numbers — List & Detail](https://docs.pilotstatus.com.br/api/numbers/list.md): GET /v1/numbers — Returns all WhatsApp numbers connected to your Pilot Status project, including their status, type, and unique identifiers.
- [POST /v1/numbers/remote-pairing — Hosted Pairing Link](https://docs.pilotstatus.com.br/api/numbers/remote-pairing.md): Generate a hosted pairing link your end customer opens to connect their WhatsApp number — with optional WhatsApp delivery, white-label branding, and Meta Embedded Signup.
- [GET /v1/numbers/{id}/status — Connection Status](https://docs.pilotstatus.com.br/api/numbers/status.md): GET /v1/numbers/{id}/status — Check the live connection status of a specific WhatsApp number in your Pilot Status project at any moment.
- [Pilot Status API Overview](https://docs.pilotstatus.com.br/api/overview.md): Base URL, x-api-key authentication, key scopes, and common HTTP errors for the Pilot Status WhatsApp API.
- [Templates API — Create, Update, Delete](https://docs.pilotstatus.com.br/api/templates.md): Manage WhatsApp message templates programmatically: POST/PUT/DELETE /v1/templates, required examples, header media, buttons, and Meta approval/rejection errors.
- [Configure Webhooks in Pilot Status — API and Dashboard](https://docs.pilotstatus.com.br/api/webhooks/configure.md): Register and manage webhook URLs via the Pilot Status API or dashboard. Subscribe to specific events or receive all events on a single endpoint.
- [Pilot Status Webhook Events — Complete Reference](https://docs.pilotstatus.com.br/api/webhooks/events.md): Reference for all Pilot Status webhook events: message received, sent, delivered, read, failed, and number connection events with payload schemas.
- [WhatsApp Numbers and Multi-Tenant Architecture in Pilot Status](https://docs.pilotstatus.com.br/concepts/numbers-and-tenants.md): Manage multiple WhatsApp numbers and build multi-tenant SaaS with Pilot Status. Each number is isolated with its own API, webhooks, and message history.
- [Official vs Unofficial WhatsApp API: Which to Use](https://docs.pilotstatus.com.br/concepts/official-vs-unofficial.md): Understand the difference between Official and Unofficial WhatsApp connections in Pilot Status, including tradeoffs, features, and how to choose the right one.
- [Reusable Message Templates and Variables in Pilot Status](https://docs.pilotstatus.com.br/concepts/templates.md): Create reusable message templates with dynamic variables in Pilot Status. Official API requires Meta approval; unofficial API supports free-form templates.
- [Real-Time Webhooks: Message Events from Pilot Status](https://docs.pilotstatus.com.br/concepts/webhooks.md): Pilot Status sends webhooks to your URL within milliseconds of message events. Learn the event types, payload structure, and how to verify and handle them.
- [Add and Connect WhatsApp Numbers in Pilot Status Dashboard](https://docs.pilotstatus.com.br/connecting-numbers.md): Add official or unofficial WhatsApp numbers to Pilot Status. Supports Meta Cloud API, Coexistence mode, and non-official connections with managed proxy.
- [Live Chat: Respond to WhatsApp from Your Dashboard](https://docs.pilotstatus.com.br/dashboard/live-chat.md): Use the Pilot Status Live Chat panel to read and reply to WhatsApp conversations from any browser in real time, without switching to your phone.
- [Message Logs and Analytics — Pilot Status Dashboard](https://docs.pilotstatus.com.br/dashboard/logs-analytics.md): View auditable message history, delivery status, and real-time analytics for all your WhatsApp numbers in the Pilot Status dashboard.
- [Pilot Status Dashboard: Manage Numbers and Messages](https://docs.pilotstatus.com.br/dashboard/overview.md): The Pilot Status dashboard lets you connect numbers, manage templates, configure webhooks, view logs, and chat live with contacts — all in one place.
- [Pilot Status FAQ: Setup, Plans, and API Integration](https://docs.pilotstatus.com.br/faq.md): Answers to common questions about Pilot Status: setup, official vs unofficial API, migration, plans, security, webhooks, and AI integration.
- [Build AI-Powered WhatsApp Agents with Pilot Status](https://docs.pilotstatus.com.br/guides/ai-agents.md): Connect LLMs and AI workflows to WhatsApp using Pilot Status webhooks, MCP server, and REST API. Build chatbots that respond in real time, 24/7.
- [Send Images, Videos, and Files via the WhatsApp API](https://docs.pilotstatus.com.br/guides/media-messages.md): Send images, audio, video, documents over WhatsApp using POST /v1/messages/send with media + mediaType. Supports public URLs and base64 (per provider).
- [Migrate to Pilot Status Without Rewriting Your Code](https://docs.pilotstatus.com.br/guides/migration.md): Switch to Pilot Status from Evolution API (Evolution GO or Evolution V2) by changing a single base URL. No code changes required with the API Layer.
- [Receive WhatsApp Messages and Delivery Events via Webhooks](https://docs.pilotstatus.com.br/guides/receive-messages.md): Set up a webhook endpoint to receive inbound WhatsApp messages and delivery events from Pilot Status in real time, with Node.js and Python examples.
- [Send WhatsApp Messages via API | Pilot Status](https://docs.pilotstatus.com.br/guides/send-messages.md): How to send template, free-form text, and media WhatsApp messages with POST /v1/messages/send using x-api-key authentication.
- [Chatwoot](https://docs.pilotstatus.com.br/integrations/chatwoot.md): Connect any WhatsApp number to Chatwoot with three credentials — Pilot Status auto-creates the inbox and webhook and keeps conversations in bidirectional sync.
- [Embed the Chat Inbox](https://docs.pilotstatus.com.br/integrations/embed-chat.md): Embed the white-label WhatsApp inbox in your own SaaS via iframe and the @pilot-status/embed SDK, with short-lived scoped session tokens.
- [Embed the Connect Page](https://docs.pilotstatus.com.br/integrations/embed-connect.md): Embed the white-label number-pairing flow (QR code or Meta Embedded Signup) in your SaaS using remote-pairing tokens and the embed SDK.
- [MCP Server](https://docs.pilotstatus.com.br/integrations/mcp-server.md): Connect AI agents to WhatsApp via the hosted Pilot Status MCP server: OAuth or x-api-key auth, 54 tools over the public /v1 API, per-number grants.
- [SDKs & n8n](https://docs.pilotstatus.com.br/integrations/sdks.md): Official Pilot Status SDKs for Node.js/TypeScript and Python, plus the native n8n community node with a Trigger node for webhooks.
- [Pilot Status: WhatsApp Infrastructure Without the Headache](https://docs.pilotstatus.com.br/introduction.md): Managed WhatsApp infrastructure for developers. Official and unofficial connections, REST API, managed proxy, webhooks, and a complete dashboard included.
- [Pilot Status Plans: Pricing and Feature Comparison](https://docs.pilotstatus.com.br/plans.md): Compare Pilot Status plans — Free, Básico, Premium, and Enterprise. Choose the right number of WhatsApp connections and features for your product.
- [Pilot Status Quickstart: Send Your First WhatsApp Message](https://docs.pilotstatus.com.br/quickstart.md): Create your Pilot Status account, connect a WhatsApp number, and send your first message via the REST API. No server or proxy setup required.
- [Best Practices & FAQ](https://docs.pilotstatus.com.br/trust/best-practices.md): Operational best practices for the Pilot Status API — error handling, retries, webhook usage, key security — plus quick answers to common errors.
- [Data Retention & PII Modes](https://docs.pilotstatus.com.br/trust/data-retention.md): Control how long Pilot Status stores message content per number: STORE_INDEFINITE, STORE_X_DAYS, or RELAY_ONLY — webhooks and Chatwoot keep working regardless.
- [Using AI/LLMs with Pilot Status](https://docs.pilotstatus.com.br/trust/llms.md): Point any AI tool at llms.txt for the canonical machine-readable reference, or connect agents directly through the hosted MCP server.
- [WhatsApp Blocks & Bans](https://docs.pilotstatus.com.br/trust/whatsapp-blocks.md): Reduce the risk of WhatsApp blocks and bans: watch spam-report rates, warm up numbers, collect opt-in, honor opt-out, and vary message patterns.