Speak AI API Authentication

How to authenticate Speak AI API requests: one Bearer API key plus a connectionId. MindCloud handles Speak AI's custom auth scheme for you.

Every Speak AI API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Speak AI 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

Create a MindCloud account at app.mindcloud.co if you do not already have one.
Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
Create a Speak AI connection in Connections. Speak AI uses its own authentication scheme. You provide whatever it requires when you create the connection — MindCloud handles the provider-specific details for you.
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 Speak AI account that should run the action. MindCloud stores and refreshes the Speak AI 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 Request Access Token with an Speak AI connection looks like this:

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

Connect Speak Ai

You need a paid Speak Ai subscription with API access before this connection will work.

Sign in to Speak Ai
Open your Speak Ai account in the browser and stay signed in while you collect the credential.
Open Developers > API Keys
In the left sidebar, scroll to the Developers section and open API Keys.
Developers → API Keys
Copy your API key
Copy an existing API key or create a new one on the API Keys page.
Paste the API key into MindCloud
Return to MindCloud and paste the API key into the connection form.
Mint a session token
Run the Request Access Token action to generate a temporary access token and refresh token for this Speak Ai account.
Paste the returned access token
Save the returned access token in the connection before running normal Speak Ai actions. Refresh token storage is optional for now.

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.