Tool Message While Running the Tool
# support
s
I've seen in your docs that you can optionally include a message for a tool while it running, but I've never seen this implemented, how can we implement this? But I don't want it to continue with the conversation without first receiving the result, so it's sort of more like a filler while we wait for the result https://cdn.discordapp.com/attachments/1418335834037420274/1418335834234556446/Screenshot_2025-09-18_at_21.39.30.png?ex=68cdbfae&is=68cc6e2e&hm=ebba082d7157e1922427942ad4f3a573b7a2ed5f9d36ee7f98111347a18ed1d6&
v
To show a message to the user while waiting for a tool result (and block further conversation until the result is ready), include a
message
property in your tool call response. For example:
Copy code
json
{
  "results": [
    {
      "toolCallId": "abc123",
      "result": "{\"status\": \"sent\"}",
      "message": "Sending your email, please hold on..."
    }
  ]
}
This message will be spoken to the user while the tool is running, and the assistant will wait for the result before continuing the conversation. Reference: [Vapi documentation](https://docs.vapi.ai/changelog/2025/4/26) Source: - [Changelog (April 26, 2025)](https://docs.vapi.ai/changelog/2025/4/26)
l
I can help you set this up so your tool calls include a temporary “in-progress” message using the speak property, ensuring the conversation pauses until the tool result is back. This way, users get real-time feedback instead of long silences. Do you also want me to show you how to structure it so it works smoothly across different tool types? @Simas
s
That would be great @Lordvickthor
m
Is there solution for this? @Lordvickthor
l
Yes, there’s definitely a solution for this. You can implement the speak property inside your tool call so the user sees a temporary message while the tool runs, and the conversation won’t move forward until the result is ready. I’ve worked on similar setups before and can walk you through the exact implementation. If you’d like, we can take this further in a private chat and go over the details for both of you. @Manuel @Simas
m
But can the speak message be different on every tool call so it doesn't repeat the same line? @Lordvickthor
s
Sure! @Lordvickthor
l
Yes, you can set a different speak message for each tool call, so it doesn’t have to repeat the same line. For example one call could say “Sending your email…” and another “Fetching your contacts…”. There’s a clear solution for this, and I can help you both get it working directly , let’s take it to a private chat @Manuel
Great! You can send me a message here, or if it’s easier, we can continue on WhatsApp. Do you use WhatsApp? @Simas
s
@User Any help here from you guys? How can I send a list of custom message for each tool call, let's say I use the same tool 10 times in one call, how can i make the message always be different? Can I do it from what I sent at the top? and if so how?
c
There is also the
messages
array for the tool which can be customized such as
request-start
and
request-complete
, and you can set multiple of these so one will be selected at random.
g
Hello! And is it possible to change this message in each tool-call inside the same call?
c
If you mean on demand during a call, it is not possible. The tools are defined and unchangeable after the call starts.