Typebot API Documentation

This is the complete API documentation for connecting to the Typebot API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Typebot: Manage workspaces, folders, typebots, and team members. Keep reading to get started.

Quickstart

Before you run your first Typebot request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Typebot connection — create or choose one in Connections. Note its connectionId.

Every Typebot action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/typebot/actions/{actionSlug}/run

You need a MindCloud API Key and a Typebot connection. Then call an action such as List Workspaces:

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": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Typebot account. See Typebot API Authentication for the full flow and how to get your connection credentials.

Typebot actions

All 23 published actions for this Typebot version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Folder
• POSTCreate Typebot
• POSTCreate Workspace
• DELETEDelete Typebot
• GETGet Folder
• GETGet Published Typebot
• GETGet Result
• GETGet Result Transcript
• GETGet Results Stats
• GETGet Typebot
• GETGet Workspace
• POSTImport Typebot
• GETList Folders
• GETList Result Logs
• GETList Results
• GETList Typebots
• GETList Workspace Members
• GETList Workspaces
• PUTPublish Typebot
• PUTUnpublish Typebot
• PUTUpdate Folder
• PUTUpdate Typebot
• PUTUpdate Workspace

Related apps

More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS