How It Works
PMS sends guest event
When a guest checks in, changes rooms, or checks out in your PMS, you send a POST request to the corresponding RecepAI endpoint.
RecepAI stores the data
The guest record is created or updated in RecepAI’s guest roster. Both the hotel dashboard and the AI receptionist have immediate access.
AI uses the data
When a guest contacts the hotel (via chat, voice, or messaging), the AI receptionist can verify their identity and room number before fulfilling requests like room service, extra towels, or early checkout.
Base URL
{slug} with the hotel’s unique identifier. You receive this alongside your API key during onboarding.
What is
{slug}?Each hotel on RecepAI has a unique slug — a short, URL-safe identifier like grand-hotel or seaside-resort. The hotel administrator will provide this to you along with the API key. It appears in every endpoint URL.Example: For “Grand Hotel Istanbul” with slug grand-hotel, the check-in endpoint is:What You’ll Need
| Item | Where to get it | Example |
|---|---|---|
| API Key | Hotel admin generates in Settings → PMS Integration | pms_live_a1b2c3d4e5f6... |
| Hotel Slug | Provided by hotel admin alongside the key | grand-hotel |
| API Documentation | You’re reading it | This site |
Available Endpoints
| Method | Endpoint | Purpose |
|---|---|---|
| POST | /{slug}/guests/checkin | Register a new in-house guest |
| POST | /{slug}/guests/update | Update guest details or change room |
| POST | /{slug}/guests/checkout | Check out a guest |
| GET | /{slug}/guests | List all in-house guests from your PMS |
| POST | /{slug}/guests/sync | Full reconciliation of guest list |
Next Steps
Authentication
Learn about API key format, Bearer tokens, and key management.
Quick Start
Send your first guest check-in in under 5 minutes.