Sign inGet started
Docs
Get started

AnnounceKit API Authentication

How to authenticate AnnounceKit API requests: one Bearer API key plus a connectionId. MindCloud stores your AnnounceKit credentials — no auth headers to build.

Every AnnounceKit API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your AnnounceKit 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 AnnounceKit connection in Connections. AnnounceKit uses a username and password. You enter them when you create the connection — MindCloud stores them securely so your requests never carry raw credentials.
  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 AnnounceKit account that should run the action. MindCloud stores and refreshes the AnnounceKit 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 Get Active Project with an AnnounceKit connection looks like this:

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

Connect AnnounceKit

You need an AnnounceKit account with access to the project you want to manage. AnnounceKit's GraphQL API requires HTTP Basic Authentication for API requests unless you are using dashboard login cookies in GraphiQL.

  1. Check your login method

    If you sign in to AnnounceKit only with Google OAuth, those Google credentials are not Basic Auth credentials for the GraphQL API.

  2. Prepare API-capable credentials

    Use an AnnounceKit account with a local email/password login, set a password for the same AnnounceKit email if the dashboard supports it, or contact AnnounceKit support for the Basic Auth credential/token to use with OAuth-only accounts.

  3. Enter Basic Auth credentials

    In the MindCloud connection form, enter the raw AnnounceKit username or email in Username and the matching AnnounceKit password or provider-confirmed Basic Auth credential in Password. Do not paste a value starting with Basic unless the connector has been changed to custom Authorization-header auth.

  4. Confirm the project id

    This app was built with project id 66505 as the default project-scoped value. Confirm this is the AnnounceKit project you want agents to use.

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.