Skip to main content
The TaskList class allows you to display a task list next to the chatbot UI.

Attributes

status
str
The status of the TaskList. We suggest using something short like “Ready”, “Running…”, “Failed”, “Done”.
tasks
Task
The list of tasks to be displayed in the UI.

Task Attributes

title
str
The task label shown in the UI. Supports Markdown formatting (e.g. **bold**, [links](url)).
status
TaskStatus
One of TaskStatus.READY, TaskStatus.RUNNING, TaskStatus.DONE, or TaskStatus.FAILED.
forId
str
Optional message ID to link the task to a chat message, enabling task navigation in history.
Markdown in Task.title is supported since version 2.9.0.

Usage

The TaskList element is slightly different from other elements in that it is not attached to a Message or Step but can be sent directly to the chat interface.