Use the MindStudio API
Learn how to activate API functionality for your app.
Overview
With the MindStudio API you can enable the programmatically invocation of workflows. This feature opens up several use cases, particularly in conjunction with logic blocks and launch variables. It allows for the integration of AI workflows as a step in larger automation processes.
Access and Enable the API
Select the Root folder of your AI.
Under the Access section, select API Access.
Select the Enable button.
Note the following to make API requests:
App ID: Unique App value.
API Key: Unique secret key. Do not share this with others.
Make Requests
Use the API to:
Run a Workflow
Use the following code snippet to invoke a specific Workflow in your app, optionally passing Variables that the Workflow can use.
Ensure to replace your-app-id
and your-api-key
with the APP ID and API Key values you obtained earlier.
Example API Request to Run a Workflow
Example API Request to Run a Workflow Asynchronously
Load an Existing Thread
The code snippet below is a request that fetches the details of an existing thread.
Ensure to replace your-app-id
and your-api-key
with the APP ID and API Key values you obtained earlier.
Example API Request to Load an Existing Thread
Specify Onboarding Variables in an API Request
Pre-fill Onboarding Variables and invoke Workflows with specific data. These Variables can be used to connect to automation tools like Zapier, providing a wide range of use cases.
Specify the Onboarding Variables and their values after Line 12 in the example API request to run a Workflow.
Last updated