# Novel API

The Novel API is used by all Novel Products to handle and manage your SaaS. 

Novel uses [Fastify](https://fastify.dev/) for its underlying routing framework.

## OpenAPI

Novel uses OpenAPI to shape the requests as much as possible. The built-in routes will have described the input and output of each endpoint. This is useful for the web client as request files are generated automatically using the spec.

[See Requests →](/novel-web/requests.md)

You can also check the stable API Reference here

{% embed url="<https://docs.novel.dev/novel-server/novel-api/api-reference>" %}

## Postman

A spec is available in Postman if you would like to explore

{% hint style="info" %}
This is always up-to-date and includes canary changes
{% endhint %}

{% embed url="<https://api.postman.com/collections/30329062-a6849217-4bf6-4b1d-aa17-491fc7e3a08a?access_key=PMAT-01JFH5YBZQFKWKQB8YNNXSJNG5>" %}
Public Postman Collection
{% endembed %}


---

# Agent Instructions: 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:

```
GET https://docs.novel.dev/novel-server/novel-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.