diff --git a/docs/src/content/docs/tools.mdx b/docs/src/content/docs/tools.mdx index 90ae98f..4c0d7d8 100644 --- a/docs/src/content/docs/tools.mdx +++ b/docs/src/content/docs/tools.mdx @@ -275,6 +275,36 @@ Automatic parameters are used when you don't want the model to specify the value ## Additional Information +### Changing Call State +For most tools, the response will include data you want the model to use (e.g. the results of a lookup). However, Ultravox has support for special tool actions that can end the call or change the call stage. + +These tool actions require setting a special response type. + +
Response Type | +Tool Action | +
---|---|
hang-up | +Terminates the call. In addition to having Ultravox end the call after [periods of user inactivity](/api/calls/#inactivitymessages), your custom tool can end the call. | +
new-stage | +Creates a new call stage. See [here](/guides/stages) for more. | +