Docs

Typebot API Authentication

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

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

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

Create a Typebot API token

You need access to the Typebot workspace account where you want this connection to run.

  1. Open your Typebot dashboard

    Sign in to Typebot and open your dashboard.

    Dashboard
  2. Open your account settings

    From the dashboard, go to Settings & Members, then open My account.

    Settings & Members → My account

  3. Create an API token

    In the API tokens section, click Create, give the token a name, and click Create token.

  4. Copy the API token

    Copy the token value and paste it into the API Key field when creating the connection in MindCloud.

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.