GraphQL API


The Calibre GraphQL API is used to build Command Line Interface (CLI) and Node.js API.

You may use the GraphQL API for cases when CLI, Node.js API or HTTP Site API are not usable for your use case. We recommend exhausting other options before using the GraphQL API.

Caution

The GraphQL API will change from time to time without notice. Most changes are backwards compatible where possible, although some may not be. If you’re looking for advice or assistance, contact our friendly support team.

Accessing the GraphQL API

The GraphQL API is accessed using an API Access Token over https (SSL):

1https://api.calibreapp.com/graphql
Tip

The API has a request limit of 10 requests per second. You can observe API HTTP request limits by viewing RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset HTTP headers. Requests made with Command Line Interface (CLI) and Node.js API are automatically throttled in accordance with the rate limit.

Required headers

Requests must be made using the following HTTP headers:

1Accept: application/json
2Authorization: Token <your token here>

Resources

Related Articles