Docs

Amberscript API Authentication

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

Every Amberscript API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Amberscript 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 Amberscript connection in Connections. Amberscript uses an API key. You generate the key in your Amberscript 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 Amberscript account that should run the action. MindCloud stores and refreshes the Amberscript 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 Jobs with an Amberscript connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/amberscript/actions/list-jobs/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 Amberscript account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect Amberscript with an API key

You need an Amberscript account and an API key generated from the Amberscript account page.

  1. Open your Amberscript account page

    Sign in to Amberscript and open the Account Page, where the official docs say your API key can be generated.

    Account Page
  2. Copy your API key

    Copy the API key you want to use for this connection and keep it private.

  3. Paste the API key into MindCloud

    Paste the API key into the Amberscript connection. This wrapper sends it as the documented apiKey query parameter on API requests.

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.