> For the complete documentation index, see [llms.txt](https://docs.mews.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mews.com/booking-engine-guide/booking-engine-api.md).

# Booking Engine API

The **Mews Booking Engine API** is a web API that allows external applications such as booking widgets to interact programmatically with Mews to get information about offered rooms or spaces for a given property, to check availability of those rooms or spaces, and to create reservations. Use this option if you want to create your own custom booking engine.

> #### OpenAPI definition
>
> We maintain an [OpenAPI definition](https://api.mews.com/swagger/distributor/swagger.json) (formerly Swagger) for the **Mews Booking Engine API**. You can use this to build out client applications using third party tools. At this stage we consider this a Beta test version, but please use it and get in touch to let us know how you get on.

* [Usage guidelines](/booking-engine-guide/booking-engine-api/guidelines.md)
* [Use cases](/booking-engine-guide/booking-engine-api/use-cases.md)
* [API Operations](/booking-engine-guide/booking-engine-api/operations.md)
* [Deprecations](/booking-engine-guide/booking-engine-api/deprecations.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.mews.com/booking-engine-guide/booking-engine-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
