Sign inGet started
Docs
Get started

Calibre API Authentication

How to authenticate Calibre API requests: one Bearer API key plus a connectionId. MindCloud stores your Calibre API key securely — set it once, never resend it.

Every Calibre API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Calibre account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a Calibre connection in Connections. Calibre uses an API key. You generate the key in your Calibre account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Calibre account that should run the action. MindCloud stores and refreshes the Calibre credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling List Sites with an Calibre connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/calibre/actions/list-sites/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Calibre account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Create a Calibre API token

You need access to the Calibre organisation and team you want this connection to use.

  1. Open the Calibre API token page

    If you are creating a Personal Access Token, click your avatar in the main navigation and open Personal Access Tokens. If you are creating an Admin Token, open Manage, then the API tab.

    Avatar menu → Personal Access Tokens
  2. Create a token for the correct team

    Add a name, choose an expiry, optionally set an IP allowlist, choose which Team's Sites the token can access, and select the permissions required for your automation.

  3. Save the token somewhere safe

    Calibre only shows the token value once after creation.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.