# RelayOS

## Docs

- [POST /v1/api-keys — Create API Key](https://docs.relayos.com.br/api-reference/api-keys/create.md): Generate an additional Bearer token for your RelayOS project. Create separate keys per environment or service so you can revoke them independently.
- [GET /v1/api-keys — List API Keys](https://docs.relayos.com.br/api-reference/api-keys/list.md): List all active API keys for your RelayOS project. Key values are not returned — only metadata including name, ID, and creation date.
- [DELETE /v1/api-keys/{id} — Revoke API Key](https://docs.relayos.com.br/api-reference/api-keys/revoke.md): Permanently revoke a RelayOS API key by its ID. Revocation is immediate — any request using the deleted key instantly returns 401 Unauthorized.
- [GET /v1/messages/{id} — Get Message Status](https://docs.relayos.com.br/api-reference/messages/get.md): Retrieve current status and metadata for a specific RelayOS message by ID. Returns delivery stage: QUEUED, SENT, DELIVERED, READ, or FAILED.
- [GET /v1/messages — List Messages](https://docs.relayos.com.br/api-reference/messages/list.md): Retrieve a paginated list of all messages sent from your RelayOS project, including their current delivery status and timestamps.
- [POST /v1/messages — Send a WhatsApp Message](https://docs.relayos.com.br/api-reference/messages/send.md): Send a transactional WhatsApp message using an approved Meta template. Pass recipient number, template name, language code, and optional variable values.
- [POST /v1/projects — Create Project](https://docs.relayos.com.br/api-reference/projects/create.md): Create a new RelayOS project and receive your API key. This is the first step to integrate WhatsApp messaging — no authentication required.
- [GET & PUT /v1/projects/me — Project Settings](https://docs.relayos.com.br/api-reference/projects/me.md): Retrieve your RelayOS project configuration or update your Meta Phone Number ID, access token, and webhook callback URL before sending messages.
- [POST /v1/templates — Create Template](https://docs.relayos.com.br/api-reference/templates/create.md): Register a new WhatsApp message template in your RelayOS project. Templates must be approved by Meta before they can be used to send messages.
- [GET /v1/templates — List Templates](https://docs.relayos.com.br/api-reference/templates/list.md): Retrieve all WhatsApp message templates registered in your RelayOS project, including their approval status and language configurations.
- [API Key Authentication for RelayOS Requests](https://docs.relayos.com.br/authentication.md): RelayOS uses Bearer token authentication. Learn how to get your first API key, pass it in requests, create additional keys, and revoke compromised ones.
- [Use Idempotency Keys to Prevent Duplicate Messages](https://docs.relayos.com.br/guides/idempotency.md): Protect against network retries creating duplicate WhatsApp messages by sending an Idempotency-Key header with every POST /v1/messages request.
- [Send WhatsApp Messages with RelayOS](https://docs.relayos.com.br/guides/send-message.md): Step-by-step guide to sending transactional WhatsApp messages using the POST /v1/messages endpoint, with template variables and status tracking.
- [WhatsApp Template Messages: Setup and Usage](https://docs.relayos.com.br/guides/templates.md): Learn how to create and use approved WhatsApp message templates with RelayOS, including dynamic variable substitution and language codes.
- [Configure Webhooks for Message Delivery Events](https://docs.relayos.com.br/guides/webhooks.md): Set up a RelayOS webhook endpoint to receive real-time delivery status updates as your WhatsApp messages move through the delivery pipeline.
- [RelayOS: WhatsApp Messaging API for Developers](https://docs.relayos.com.br/introduction.md): RelayOS is a REST API for sending transactional WhatsApp messages via Meta's official Cloud API, billed in BRL with automatic retry and real-time webhooks.
- [Quickstart: Send Your First WhatsApp Message](https://docs.relayos.com.br/quickstart.md): Learn how to create a RelayOS project, configure Meta credentials, and send your first WhatsApp message in under 5 minutes with three API calls.

## OpenAPI Specs

- [openapi](https://docs.relayos.com.br/api-reference/openapi.json)