REST API
Read and manage supported Vivollo resources from your own systems.
Use the REST API to read Vivollo data or manage supported resources from your code.
Authentication
Send an API key with every request:
Authorization: Bearer YOUR_API_KEYThe key limits access to its Vivollo workspace.
Available resources
The API can provide supported operations for:
- Conversations and messages
- Collections and documents
- Flows and assistants
- Insights data
Endpoints use JSON and standard HTTP methods such as GET, POST, PATCH, and DELETE. List endpoints are paginated.
Add knowledge from your system
Use the bulk document endpoints to add or remove several documents in a collection. This is useful when your CMS or internal system is the source of truth and no ready-made connector exists.
REST API or API request action?
- Use the REST API for syncing, reporting, and managing resources around Vivollo.
- Use the API request action when a flow needs your system during a live customer conversation.
Webhooks and the REST API often work together:
conversation.updated webhook
→ fetch the full conversation with the REST API
→ update your own system