additional_instructions
# support
p
how to pass call specific instructions (client details) when starting a call? just like openai assistants has the
additional_instructions
?
also, for using custom tools, can we pass custom parameters when creating a call?
v
You can continue this conversation by mentioning me in the message.
@Phones.Trade/join To pass call-specific instructions or client details when starting a call, similar to how you would use
additional_instructions
with OpenAI assistants, you would typically include these details in the API request that initiates the call. This can be done by adding a parameter in your API request that contains the instructions or details you want to pass along. For example, if you're using a Voice API, you might have a parameter like
custom_instructions
or
client_details
where you can include the necessary information. The exact parameter name and method of inclusion can vary depending on the API you're using, so you'll want to refer to the API documentation for the specific syntax and guidelines. Here's a hypothetical example of what the API request might look like in JSON format:
Copy code
json
{
  "phone_number": "+1234567890",
  "message": "Hello, this is your appointment reminder.",
  "custom_instructions": {
    "client_name": "John Doe",
    "appointment_time": "10:00 AM",
    "special_notes": "Client prefers a text reminder as well."
  }
}
In this example,
custom_instructions
is an object that contains the call-specific instructions or client details. When the call is initiated, the Voice API would use these details to tailor the call experience according to the provided instructions. If you're using a specific Voice API and need to know how to include these details for that particular service, please provide the name of the API or any additional context, and I can give you more precise guidance.
Got it. Tagging @User for additional help.
p
the above is indeed what i need, but i can't find it in the VAPI documentation. 🙂
is there such option for VAPI @Vapi ?
v
@Phones.Trade/join I apologize for any confusion. If you are unable to find the information regarding passing call-specific instructions or client details in the VAPI documentation, it's possible that this feature may not be explicitly documented or may not exist in the same form as with other APIs. However, VAPI might still support custom parameters in some way. To get the most accurate information, I would recommend reaching out directly to VAPI support or checking their API reference section for any updates or additional features that may not be immediately visible in the general documentation. If VAPI does support custom parameters, it would typically be included in the API call setup, possibly in the payload of the request when you initiate a call. The documentation or support team should provide you with the exact parameter names and the structure required to pass such information. If you need further assistance with this or any other feature, please let me know, and I'll do my best to help you. If the feature is not available, VAPI support might be able to provide alternative solutions or consider it for future updates.
s
use server event request-assistant and assistant-overrides. ref: https://docs.vapi.ai/server-url/events#retrieving-assistants