Endpoint Examples
Vapi - Get Context
Retrieves the context for a VAPI call using the customer’s phone number
POST
/
voice
/
api
/
v1
/
vapi
/
get-context
Copy
curl --request POST \
--url https://protegee.ai/voice/api/v1/vapi/get-context \
--header 'Content-Type: application/json' \
--data '{
"message": {
"customer": {
"number": "+1234567890"
},
"toolCalls": [
{
"id": "123456789",
"function": {
"name": "GetContextFromProtegee"
}
}
]
}
}'
Copy
{
"results": [
{
"toolCallId": "<string>",
"result": {
"caller": "<string>",
"description": "Reservation for two at The Gourmet Bistro, 7:30 PM on December 30th, 2024, Table 12, Indoor seating, Special request: Window view, Confirmation number: 12345",
"price": "10.00",
"vendor": "example-co",
"customer_id": "",
"persona": "english-jessica",
"callback": "+14155552671",
"email": "[email protected]",
"full_name": "John Doe",
"transaction_type": "once",
"memory": "",
"status": "payment-success",
"start_time": "2024-12-30T02:59:32.213280+00:00",
"processor": {},
"debug": ""
}
}
]
}
Query Parameters
API token for authentication
Body
application/json
Response
200
application/json
Successfully retrieved context
The response is of type object
.
Copy
curl --request POST \
--url https://protegee.ai/voice/api/v1/vapi/get-context \
--header 'Content-Type: application/json' \
--data '{
"message": {
"customer": {
"number": "+1234567890"
},
"toolCalls": [
{
"id": "123456789",
"function": {
"name": "GetContextFromProtegee"
}
}
]
}
}'
Copy
{
"results": [
{
"toolCallId": "<string>",
"result": {
"caller": "<string>",
"description": "Reservation for two at The Gourmet Bistro, 7:30 PM on December 30th, 2024, Table 12, Indoor seating, Special request: Window view, Confirmation number: 12345",
"price": "10.00",
"vendor": "example-co",
"customer_id": "",
"persona": "english-jessica",
"callback": "+14155552671",
"email": "[email protected]",
"full_name": "John Doe",
"transaction_type": "once",
"memory": "",
"status": "payment-success",
"start_time": "2024-12-30T02:59:32.213280+00:00",
"processor": {},
"debug": ""
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.