> ## Documentation Index
> Fetch the complete documentation index at: https://docs.recepai.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# PMS Integration API

> Push guest check-in, update, and checkout data from your PMS to RecepAI in real time.

RecepAI is an AI-powered receptionist used by hotels to handle guest inquiries, service requests, and communications. To function effectively, RecepAI needs to know **who is currently staying at the hotel** — which guests are in which rooms, their names, phone numbers, and stay dates.

The PMS Integration API lets your Property Management System push this guest data to RecepAI automatically. No manual entry, no CSV uploads, no delays.

## How It Works

```mermaid theme={null}
flowchart LR
    PMS["🏨 Your PMS"]
    API["RecepAI API"]
    Roster["Guest Roster"]
    AI["AI Receptionist"]
    Dashboard["Live Dashboard"]

    PMS -- "check-in / update / checkout / sync" --> API
    API --> Roster
    API --> AI
    API --> Dashboard

    style PMS fill:#222222,stroke:#C09A40,color:#FFFFFF
    style API fill:#C09A40,stroke:#222222,color:#222222
    style Roster fill:#f9f9f9,stroke:#6B7280,color:#222222
    style AI fill:#f9f9f9,stroke:#6B7280,color:#222222
    style Dashboard fill:#f9f9f9,stroke:#6B7280,color:#222222
```

<Steps>
  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Dashboard updates in real time">
    Hotel staff see guest arrivals, departures, and room changes on their dashboard instantly via server-sent events.
  </Step>
</Steps>

## Base URL

```
https://app.recepai.ai/api/pms/v1/{slug}
```

Replace `{slug}` with the hotel's unique identifier. You receive this alongside your API key during onboarding.

<Info>
  **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:

  ```
  POST https://app.recepai.ai/api/pms/v1/grand-hotel/guests/checkin
  ```
</Info>

## 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`](/api/pms/checkin)   | Register a new in-house guest          |
| POST   | [`/{slug}/guests/update`](/api/pms/update)     | Update guest details or change room    |
| POST   | [`/{slug}/guests/checkout`](/api/pms/checkout) | Check out a guest                      |
| GET    | [`/{slug}/guests`](/api/pms/list-guests)       | List all in-house guests from your PMS |
| POST   | [`/{slug}/guests/sync`](/api/pms/sync)         | Full reconciliation of guest list      |

## Next Steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api/pms/authentication">
    Learn about API key format, Bearer tokens, and key management.
  </Card>

  <Card title="Quick Start" icon="rocket" href="/api/pms/quick-start">
    Send your first guest check-in in under 5 minutes.
  </Card>
</CardGroup>