What the Assistant is
Think of the Assistant as a colleague who already knows how to use every service you have connected to ModuleX. You ask in plain language; it works through the task and reports back.It uses your tools
The Assistant searches your connected integrations and calls their actions directly — for example, listing your repositories or sending a message — using your organization’s stored credentials.
It works step by step
Each request becomes a turn. The Assistant streams its thinking, calls one tool at a time, reads the result, and keeps going until the task is done.
It asks before acting
For sensitive actions it stops and shows an approval card. Nothing risky runs until you say yes.
What it can do
Call integration tools
Run a single action on a connected service, like “list my GitHub repos” or “create a Linear issue.” The Assistant discovers which tools exist and runs them for you.
Connect what's missing
If a task needs a service you have not connected yet, the Assistant asks you to add the credential — including starting an OAuth connection — right inside the chat.
Search your knowledge
Answer questions from your connected knowledge bases with retrieval, so replies are grounded in your own documents.
Pause for your input
Ask you a question, offer choices, or request approval mid-task, then continue once you answer.
The Assistant is text-only today: each turn is a single text message. It does not build or run workflows, and it does not accept file uploads or
messages[] history in a single turn.Assistant vs Composer vs Builder
ModuleX gives you three ways to get things done. They are easy to tell apart once you know what each one produces.Assistant
Acts for you, now. A chat that calls your tools step by step to complete a task. Produces results and answers — not a saved workflow.
AI Composer
Builds a workflow for you. A chat copilot inside the builder that turns a plain-English description into an editable workflow graph you can save and reuse.
Workflow builder
You build it by hand. The visual canvas where you drag, connect, and configure nodes yourself for full control.
| Assistant | AI Composer | Workflow builder | |
|---|---|---|---|
| What you get | Work done in the chat — answers and completed actions | An editable, reusable workflow graph | An editable, reusable workflow graph |
| How you drive it | Plain-language chat | Plain-language chat | Drag, connect, and configure nodes by hand |
| Touches your workflows? | No — it has no workflow tools | Yes — it creates and edits the graph | Yes — you are editing the graph |
| Calls your tools live? | Yes, directly during the chat | While building, not as a saved run | When you run the workflow |
| Reusable later? | The chat is saved; the result is one-off | Yes — the workflow can be run again | Yes — the workflow can be run again |
| Best for | One-off tasks and quick questions | Going from idea to a workflow fast | Precise, complex automations |
The Assistant and the AI Composer share the same chat engine and the same approval and pause-for-input behavior, but they are separate surfaces. The Composer edits a workflow graph; the Assistant has no workflow tools whatsoever. The workflow builder is the canvas both of them — and you — can edit.
When to use the Assistant
Use the Assistant when
- You want something done once, right now — a lookup, a summary, a quick post.
- The task spans a few connected services and you would rather describe it than wire it.
- You want an answer grounded in your own knowledge.
- You are exploring what your connected tools can do.
Use Composer or the builder when
- You will repeat the task and want to save it as a workflow.
- You need to schedule it, trigger it from an API, or run it from chat.
- You need branching, loops, retries, or precise control over each step.
- You want to share a reusable automation with your team.
How to start a session
The Assistant lives at the chat surface of the ModuleX app. Starting a session takes one message.1
Open the chat surface
Sign in to the ModuleX app and open the chat. The Assistant greets you with a few starter prompts you can use as a launching point.
2
Describe your task in plain language
Type what you want done — for example, “Summarize my newest support tickets” — and send. A starter chip fills the box for you but does not send on its own, so you can edit it first.
3
Watch it work
The Assistant streams its reply live: you see its thinking, each tool it calls, and the result of each call as it goes. You can stop a turn at any time. Learn more in streaming responses.
4
Answer when it asks
If the Assistant needs a choice, a piece of information, or approval for a sensitive action, it pauses and shows you a question or an approval card. Answer it and the Assistant continues. See human-in-the-loop.
5
Connect a tool if prompted
If the task needs a service you have not connected, the Assistant asks you to add the credential — including starting an OAuth connection — without leaving the chat. See authentication and credentials.
Who can use the Assistant?
Who can use the Assistant?
The Assistant is scoped to one of your organizations. As built today, you must have the owner or admin role in that organization to start or continue an Assistant chat; other members receive a permission error. The retired
member role is not a current role. See roles and permissions and permissions and limits for the full picture.One question at a time per chat
One question at a time per chat
A chat can hold only one open question at a time. While the Assistant is waiting for your answer, or while a turn is still running, it will not start another turn on the same chat — you finish the current step first. This keeps each conversation predictable.
Does the Assistant use credits?
Does the Assistant use credits?
Yes. Each turn is metered like any other managed run, and language-model token usage is recorded separately. If your plan’s allowance is exhausted, the turn is declined before anything runs, and you will see a clear billing message. See credits and the billing model and usage gating and limits.
Start the Assistant from your own code
You can also drive the Assistant programmatically. A turn starts with one authenticated request that creates or continues a chat and returns a stream URL; you then open that stream to watch the turn unfold. Every request usesAuthorization: Bearer mx_live_… plus your X-Organization-ID header — see authentication.
stream_url, which you open over Server-Sent Events to receive the Assistant’s actions and output as they happen:
Response
To talk to the Assistant programmatically, always use the
/assistant/chat request shown above — that is the supported path. For the full set of Assistant operations, see how the Assistant works and streaming responses.Where to go next
How the Assistant works
The agentic loop: how the Assistant reasons, picks a tool, acts, observes the result, and decides when it is done.
The Assistant concept
Where the Assistant fits in the ModuleX mental model, and how it relates to the Composer and the engine.
Using tools
How the Assistant discovers and calls integration tools, and how it requests credentials.
Chat overview
A tour of the chat surface where the Assistant lives, and how it sits alongside knowledge and workflow runs.
Human-in-the-loop
How the Assistant pauses for a question or an approval, and how you respond.
Examples
Worked examples of common Assistant tasks, end to end.