# Slotr

Slotr is booking-as-infrastructure. Take bookings from a simple link, or build
your own booking product on the same engine — powered by an AI index that
actually understands your business.

## What Slotr is for

Our mission is to make taking bookings effortless for any business, and to give
developers a booking backend they never have to build. Courts, clinics, studios,
rentals, listings — Slotr turns anything you offer into something a customer can
find and book in seconds.

## Who it's for

- Businesses that take appointments or reservations and want a booking link that
  just works.
- Developers and product teams putting booking inside their own app — who want
  search, availability and booking as an API instead of months of work.
- AI agents that need to find and book on a user's behalf.

## Bookables — your entities

A bookable is anything people can book: a padel court, a doctor, a meeting room,
a rental, a listing. You sync your own entities into Slotr as bookables, each
with a name and the attributes that matter to your business. Your system stays
the source of truth — Slotr keeps a smart, searchable copy.

## Indexing — teaching Slotr your catalog

Indexing is how your entities get into Slotr. Push one or thousands at once and
Slotr builds an always-fresh index of everything you offer. The more you sync,
the better Slotr knows your catalog.

## Intelligent search

Slotr doesn't just match keywords. It learns your domain with AI — grasping what
your attributes mean and how your entities relate — so a customer's request finds
what they actually want, not just literal filters. And it gets sharper the more
you use it.

## Build on it

- Booking Kit — drop a themeable booking UI into any React app.
- API — index, search and book over HTTP.
- MCP — give AI agents the same powers, as tools.

---

# Docs

- [Slotr Docs](/docs): Embed the Slotr booking experience, or build on booking-as-infrastructure with the API and MCP.
- API: The Slotr public HTTP API
  - [Getting Started](/docs/api): The Slotr API — booking as infrastructure.
  - Bookables
    - [List bookables in the project](/docs/api/bookables/listBookables): Returns a page of bookable entities ordered by most recently updated. Use it to browse or sync what the project has indexed; use search when you need to filter by attributes
    - [Get one bookable by its key](/docs/api/bookables/getBookable): Returns the bookable identified by type and externalId, including archived ones. Use it to read back a single indexed object
    - [Create or replace one bookable](/docs/api/bookables/upsertBookable): Creates the bookable or fully replaces its name, status and attributes, keyed by type and externalId. Use it to index or update a single object from your database; the type is created on first use. Sending status active restores an archived entity
    - [Archive one bookable](/docs/api/bookables/archiveBookable): Archives the bookable so it is kept for history but excluded from search. Idempotent — archiving an archived entity still returns it. Entities are never hard-deleted through the API
  - Health
    - [Service and dependency health](/docs/api/health/getHealth)
  - Indexing
    - [Index (create or replace) many bookables in one call](/docs/api/indexing/indexBookables): Indexes up to 500 bookables — creating or replacing each — for initial sync or bulk updates. Not atomic: each item succeeds or fails on its own and the response reports the outcome per input index
  - Search
    - [Search bookables by attribute filters](/docs/api/search/searchBookables): Runs a structured, deterministic search over one bookable type using AND-combined attribute filters. Filtering on an attribute path no entity of the type has returns 400 with the valid paths. Prices use the money convention { amount (integer minor units), currency (ISO 4217) }; filter on price.amount
- Booking Kit: React components for the Slotr booking experience
  - [Getting Started](/docs/booking-kit): Slotr's React components for the booking experience.
  - <BookingCalendar />
    - [<BookingCalendar />](/docs/booking-kit/booking-calendar): Drop the Slotr booking experience into any React app with one component.
    - [Basic Usage](/docs/booking-kit/booking-calendar/usage): Real BookingCalendar scenarios — preview on top, code below.
    - [Theming](/docs/booking-kit/booking-calendar/theming): Restyle the booking widget from props — accents, radius, and custom backgrounds.
    - [Dialog](/docs/booking-kit/booking-calendar/dialog): Open booking in the out-of-the-box modal with BookingCalendar.Dialog.
    - [Prefilling](/docs/booking-kit/booking-calendar/prefill): Pre-fill the details and deep-link straight to a slot.
    - [Headless](/docs/booking-kit/booking-calendar/headless): Bring your own UI — the booking URL + resize logic, with zero CSS.
    - [Props](/docs/booking-kit/booking-calendar/props): The BookingCalendar and BookingCalendar.Dialog prop contracts.
- MCP: The Slotr Model Context Protocol server
  - [Getting Started](/docs/mcp): Give AI agents Slotr tools over the Model Context Protocol.
  - Installation
    - [Installation](/docs/mcp/installation): Connect your MCP client to the hosted Slotr server.
    - [Claude Code](/docs/mcp/installation/claude-code): Connect Claude Code to the Slotr MCP server.
    - [Cursor](/docs/mcp/installation/cursor): Connect Cursor to the Slotr MCP server.
    - [Codex](/docs/mcp/installation/codex): Connect Codex to the Slotr MCP server.
    - [VS Code](/docs/mcp/installation/vscode): Connect VS Code to the Slotr MCP server.
  - [Tools](/docs/mcp/tools): Every Slotr tool an agent gets over MCP.