Skip to main content

Run a Dify Workflow

Dify is a platform for building multi-step AI workflows. ConsoleX can call Dify workflows as tools, so the AI can hand part of a chat or task to a workflow you built. Dify workflows can run on Dify Cloud or in a self-hosted deployment.

Changed in October 2026

The ConsoleX tool form changed in October 2026. The HTTP API form no longer has a Dify interface type. Add your workflow as a custom HTTP API tool that calls the workflow's API, or connect it through MCP if your Dify setup can publish the workflow as an MCP server.

Basic steps​

  1. Publish the workflow in Dify. All workflows in a Dify workspace share the same API server base URL, which your ConsoleX tool calls. Create an API key for the workflow. The variables returned by the workflow's end node become the tool result.
  2. Add a custom tool in ConsoleX. Click … (More) in the left rail, then Capabilities. On the Tools tab, click Add custom tool, then HTTP API.
  3. Describe the inputs. In Enter JSON Schema for Tool Definition, describe the input parameters your Dify workflow expects. The format follows the OpenAI tool schema. Generate by AI can draft it, and View help shows the format.
  4. Set how it's called. Under Invocation Method, choose GET or POST. Fill in the endpoint details the form asks for with the API server URL from step 1, and enter the Dify API key where the form asks for one. Click Save.
  5. Use it. Turn the tool on in a chat (Tools under the message box) or in a task or agent (Add capabilities). The model calls the workflow based on the tool's description and inputs.

Create a Tool dialog with the JSON Schema editor and GET, POST and Use Mock Data

Because the form no longer has a Dify-specific option, make sure the request your tool sends matches what Dify's workflow API expects. Test with a short chat and check the result before you use the tool in a task. See Add a custom tool and Add an MCP server.

Example workflow​

Here is a sample Dify weather workflow you can save and import into Dify:

Weather workflow

Notes​

  1. The tool's JSON Schema must match the workflow's input parameters, otherwise the model won't call the workflow correctly. Check call details in Dify's run history.
  2. The workflow must be published before ConsoleX can call it.