Getting Started
The Slotr API — booking as infrastructure.
The Slotr API is booking as infrastructure. You sync your own domain objects — listings, doctors, courts, rooms — into Slotr as bookables, keyed by your id, while your database stays the source of truth.
From there, Slotr gets to know your entities. It keeps an indexed copy and continuously enriches it offline with AI — learning your domain, filling in what attributes mean and sharpening how things relate. So searches match what a customer actually wants, not just literal filters — and they get better the more you sync. On top of that index you search, quote and book.
Every operation below is generated from the OpenAPI contract — the same contract the SDKs and the server types are built from, so the docs never drift from the API.
Base URL
| Environment | URL |
|---|---|
| Production | https://api.slotr.dev |
| Local | http://localhost:3000 |
Authentication
Every endpoint except health requires a JWT in the
Authorization header.
Authorization: Bearer <your-token>Requests are scoped to your project by the token — you only ever see and write your own bookables.
How it works
- Index your entities into Slotr (bulk for the
first sync, or one at a time). Each bookable is
keyed by a
type(customer-defined, created on first use) and yourexternalId. - Search indexed bookables by attribute filters to find what fits a request.
- Book — pair the API with the Booking Kit to turn a bookable into a confirmed booking.
Endpoints
Bookables
List, read, create/replace (upsert) and archive individual bookables.
Indexing
Bulk create-or-replace many bookables in one call — for the initial sync and bulk updates.
Search
Structured attribute search over indexed bookables.
Health
Liveness and readiness of the service and its dependencies. Public.
Reference
| Method | Path | What it does |
|---|---|---|
GET | /v1/bookables | List bookables in the project |
PUT | /v1/bookables/{type}/{externalId} | Create or replace one bookable |
GET | /v1/bookables/{type}/{externalId} | Get one bookable by its key |
DELETE | /v1/bookables/{type}/{externalId} | Archive one bookable |
POST | /v1/index | Index (create or replace) many at once |
POST | /v1/search | Search bookables by attribute filters |
GET | /health | Service and dependency health |
Pick any operation from the sidebar (or the links above) to see its parameters, request body, responses, and an interactive request playground.