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.
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
Required headers
Requests must be made using the following HTTP headers:
1Accept: application/json2X-Client-Name: <your client name. String - eg: `CalibrePython`>3X-Client-Name: <your client version. String - eg: `1.0.0`>4Authorization: Token <your token here>
Resources
- Calibre GraphQL API Documentation
- Check the examples of API queries for the CLI and Node.js API.
- View the Node.js examples to get an idea of what operations are possible.
- Learn how to use GraphQL from scratch, or find a client library for your language.