HyperXIDocs

Getting Started with HyperXI

Go from zero to a fully operational booking platform in under 30 minutes. Follow these 8 steps to set up your escape room business on HyperXI.

1

Create your account

Sign up at hyperxi.com/signup. Enter your business name, email, and choose a company slug. The slug becomes your unique booking URL: hyperxi.com/book/your-slug

When complete, you should see:

The admin dashboard at /admin with your company name in the header.

2

Add your first location

Navigate to /admin/rooms. A default location was created during signup. Click it to edit the name, street address, and timezone.

The timezone is critical -- it determines how your schedule slots are displayed to customers and how DST transitions are handled.

When complete, you should see:

Your location listed with the correct name, address, and timezone on the Rooms page.

3

Add rooms

Still on /admin/rooms, click "Add Room" to create your escape rooms. For each room, set:

  • Name -- e.g., "Wizard's Tower", "Prison Break"
  • Description -- the storyline and theme your customers will see
  • Difficulty -- easy, medium, hard, or expert
  • Pricing -- flat rate, per-person, or tiered pricing
  • Player limits -- minimum and maximum players per session
  • Duration -- how long the experience lasts (in minutes)

When complete, you should see:

Your rooms listed on the Rooms page with their name, difficulty badge, and pricing displayed.

4

Set up schedules

Navigate to /admin/schedule. Create recurring schedule templates that define when each room is available. Each template specifies:

  • Room -- which room the template applies to
  • Day of week -- Monday through Sunday
  • Time -- the start time for the slot
  • Capacity -- max bookings for this slot (usually 1 for escape rooms)

After creating templates, generate time slots. This creates concrete bookable slots for the next 30 days based on your templates. Slot generation also runs automatically every day at 2am.

When complete, you should see:

A calendar view showing generated time slots for each room across the next 30 days.

5

Configure your waiver

Navigate to /admin/waivers. Create a waiver template with sections covering liability, photo release, or any other terms your participants need to sign before playing.

Customers receive automatic waiver reminders via email and SMS before their booking. Each participant in a booking must sign individually.

When complete, you should see:

Your waiver template listed on the Waivers page, marked as the active version.

6

Generate an API key

Navigate to /admin/settings and find the API Keys section. Click "Create API Key" and give it a descriptive name (e.g., "Claude Desktop MCP").

Copy the key immediately -- it will only be shown once. You will use this key to authenticate your AI tools via the MCP server.

When complete, you should see:

The API key listed in your settings with its name and creation date. The key value is hidden after initial display.

7

Connect your AI

Follow the MCP Quickstart guide to connect Claude Desktop (or any MCP-compatible client) to HyperXI. You will add the HyperXI MCP server to your client's configuration with your API key.

Once connected, your AI can manage bookings, schedules, customers, and more through natural conversation.

When complete, you should see:

The HyperXI tools available in your AI client. Ask it "List my rooms" to verify the connection.

8

Test a booking

Visit your public booking page at hyperxi.com/book/your-slug to test the full customer booking flow. Select a room, pick a date and time slot, enter customer details, and complete a test payment.

Use Stripe's test card number 4242 4242 4242 4242 with any future expiry date and any CVC.

When complete, you should see:

A booking confirmation page with a booking reference code. The booking appears in /admin/bookings with status "confirmed".

What's next?