Vivollo

REST API

Read and manage your Vivollo data programmatically — conversations, collections, flows, and more — over a straightforward REST API.

When your code needs to reach into Vivollo — to read conversations, manage your knowledge, or sync data into your own systems — you use the REST API. It's the programmatic door to your workspace, authenticated with an API key.

It's an ordinary REST API: predictable URLs, standard HTTP methods, and JSON in and out. If you've worked with any modern web API, you'll feel at home immediately.

Authenticating

Every request carries your API key as a bearer token:

Authorization: Bearer YOUR_API_KEY

The key scopes every request to your own workspace — you can only ever read and change your own data, never another customer's.

What you can work with

The API exposes the core of your workspace as REST resources, including:

  • Conversations and messages — read the threads your agent and team have handled, and the messages within them.
  • Collections and documents — manage your knowledge: create collections, and add or remove documents.
  • Flows and assistants — the building blocks of your agent.
  • Insights — the classified, analyzed view of your conversations: segments, breakdowns, and trends.

Resources follow the usual REST shape — list and read with GET, create with POST, update with PUT/PATCH, remove with DELETE — and list endpoints are paginated.

Pushing knowledge in

A common use of the API is feeding your agent knowledge from your own systems — handy when your content lives somewhere Vivollo doesn't connect to out of the box (see Adding content). There's a bulk document endpoint for exactly this: push a batch of documents into a collection in one call, and remove them the same way. Your CMS or backend can keep a collection in sync as your content changes.

Getting started

The path is short:

  1. Create an API key.
  2. Send requests to the Vivollo API with the key in the Authorization header.
  3. Read what you need, or push documents into your collections.

For acting during a live conversation rather than around it, you usually don't need the REST API at all — the no-code API Call action lets a flow reach your systems mid-conversation. Reach for the REST API when you're integrating around Vivollo (syncing, reporting, bulk knowledge); reach for the API Call action when you're integrating inside a conversation.

Pairing with webhooks

The REST API and webhooks are a natural pair. A webhook tells you something happened; the API lets you fetch the full picture when the notification alone isn't enough. A common pattern:

conversation.updated webhook fires → your code calls the API to pull the full conversation → you act on it in your own system.

Start by creating an API key — it's the front door to everything here.