Skip to main content

Run a Coze Workflow

Coze is a platform for building workflows and AI apps. ConsoleX can call Coze workflows as tools, so the AI can run a workflow you built during a chat or task.

Changed in October 2026

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

Basic steps​

  1. Create and publish the workflow in Coze. The workflow should start with a Start node and end with an End node. Set the End node to return response text, and assemble a JSON object whose fields become the tool result.
  2. Find the API details. Coze runs workflows through its workflow API, which identifies each workflow by its workflow ID. The international and China versions use different API hosts:
    • International: https://api.coze.com
    • China: https://api.coze.cn
  3. 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.
  4. Describe the inputs. In Enter JSON Schema for Tool Definition, describe the input parameters your Coze workflow expects. The format follows the OpenAI tool schema. Generate by AI can draft it.
  5. Set how it's called. Under Invocation Method, choose POST, fill in the endpoint details the form asks for with the Coze workflow API, and enter your Coze token where the form asks for an API key. Click Save.
  6. 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 Coze-specific option, make sure the request your tool sends matches what Coze's workflow API expects, including the workflow ID. Test with a short chat before you use the tool in a task. See Add a custom tool and Add an MCP server.

Notes​

  1. The tool's JSON Schema must match the workflow's input parameters, otherwise the model may not call the workflow correctly. Use Coze's run history for debugging.
  2. A Coze workflow must be published before it can be called.

Common issue: auth tokens​

Coze workflows use token-based authentication. Create a token in Coze's Authorization area and make sure it has the permissions the workflow needs. Coze tokens have an expiry date, so check it when you create the token and update the token your ConsoleX tool uses before it runs out.