Human Handover
Enable or disable human handover on an active conversation.
PATCH /api/v1/conversations/:id/human-handover
Switch a conversation between virtual being mode and human operator mode. When human handover is enabled, the system signals that a human operator has taken control of the conversation.
Path Parameters
- id – the conversation's unique identifier (UUID)
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | yes | true to enable human handover, false to return to virtual being |
Enable Human Handover
curl -X PATCH \
"https://my-assistant.virbe.app/api/v1/conversations/CONVERSATION_ID/human-handover" \
-H "x-virbe-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": true
}'Disable Human Handover
curl -X PATCH \
"https://my-assistant.virbe.app/api/v1/conversations/CONVERSATION_ID/human-handover" \
-H "x-virbe-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": false
}'This endpoint requires an API key with the ConversationActions scope.
The response returns the full conversation object. The humanHandover field in the response confirms the current state.