progress
Shows a short progress message to the user while the agent works. The message is not part of the agent's output.
Value
| Value | Type | Default | Description |
|---|---|---|---|
| the command's value | dynamic string | Sends a progress message to the UI. The message is not part of the agent's output. |
Example
"progress": "{ f'Got your location: {location['city_name']}, {location['region_name']}' }",
"api": { "url": "{ forecastUrl }" },
"progress": "Found the weather for the next 8 hours"Rules
- The value is converted to a string and sent immediately on the execution stream, so the user sees the message while the agent runs.
- Progress messages are not saved with the conversation, so they do not appear when the conversation is opened again later.

