Getting Started

EscapeLife API

The EscapeLife REST API lets you build on top of the hospitality platform — connecting properties, guest intelligence, reservations, revenue workflows, and operational coordination into your own applications and integrations.

Base URL

text

https://api.escapelife.ai/v1

Local development: http://localhost:8000/v1

Authentication

All requests require authentication via the Authorization header or the X-API-Key header. Keys are scoped per property and per environment.

Request header (either format accepted)

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx
# or
X-API-Key: sk_live_xxxxxxxxxxxxxxxxxxxx

Use sk_test_ keys for sandbox testing. Authentication guide →

Quickstart

1. Create a property (one-time setup)

curl -X POST https://api.escapelife.ai/v1/properties \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Grand Sunset Resort",
    "slug": "grand-sunset-resort",
    "type": "resort",
    "timezone": "America/New_York",
    "currency": "USD"
  }'

2. Ingest a knowledge source

curl -X POST https://api.escapelife.ai/v1/knowledge/ingest \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Spa Menu",
    "type": "menu",
    "content": "Swedish Massage (60 min) — $150. Deep Tissue (90 min) — $200..."
  }'

3. List your knowledge sources

curl https://api.escapelife.ai/v1/knowledge/sources \
  -H "Authorization: Bearer sk_live_xxx"

API modules

AuthenticationAvailable

API key management, scopes, and environments.

PropertiesAvailable

Create and manage hospitality property records.

Knowledge BaseAvailable

Ingest documents for RAG-powered AI responses.

GuestsEarly access

Guest profiles, preferences, and stay history.

MessagingEarly access

Structured guest communication across channels.

AIEarly access

Chat, intent detection, and voice sessions.

ReservationsAvailable

Full reservation lifecycle — create, check-in, check-out, cancel.

Revenue & Yield EngineAvailable

Dynamic pricing recommendations, KPI snapshots, and Co-Pilot.

Guest RequestsAvailable

Housekeeping, maintenance, concierge, and F&B request queue.

HousekeepingAvailable

Room task management, attendant assignment, and status tracking.

ReviewsAvailable

Guest review ingestion, sentiment, and management response.

PackagesAvailable

Stay packages, bundles, and upsell offer management.

AvailabilityPlanned

Real-time room and unit availability calendar.

PaymentsPlanned

Deposits, charges, and refund management.

Authentication guide Request API access