vapi4k-core/com.vapi4k.api.tools/Server

Server

interface Server : ServerProperties

This is the server that will be hit when this tool is requested by the model.
All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.
This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.

Properties

Link copied to clipboard
abstract var secret: String

This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.
Same precedence logic as server.

Link copied to clipboard
abstract var timeoutSeconds: Int

This is the timeout in seconds for the request to your server. Defaults to 20 seconds.
@default 20

Link copied to clipboard
abstract var url: String

API endpoint to send requests to.