🔒
Conserver.io
  • 👋Welcome to the Home of the vCons
  • Overview
    • 💬A vCon Primer
    • 🌎vCons are...
    • 🧠Why vCons?
    • 💡Concepts
    • ✨More Information
    • PYTHON LIBRARY
    • 🐰Quickstart
    • Library API
    • Cheat Sheet
    • GitHub Repo
  • Conserver
    • 🚀Conserver Introduction
    • 🐰Conserver Quick Start
    • Configuring the Conserver
    • 🏫Concepts
    • ❤️Inside the Conserver
    • 🔗Standard Links
    • 🗄️Storage
    • 📆Day In the Life of a vCon
    • 🧩API
    • 🔌Integrating Your App
    • GitHub Repo
  • HELPS and HACKS
    • Coding Prompt Cheat Sheet
  • Deep Dives
    • GitHub Repo
    • vCon IETF Working Group
  • VCon Use Cases
    • Overview
    • Service Provider Migration
    • Speech Recognition Test Set
    • AI Integration
    • PII Compliance
    • Customer Experience Improvement
    • Sharing Conversations with Third Parties
    • Verbal Agreements - Converted to Writing
    • Authenticating and Certifying Conversations
    • Insights from Customer Conversations
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
Export as PDF
  1. Conserver

API

PreviousDay In the Life of a vConNextIntegrating Your App

Last updated 8 months ago

Was this helpful?

Introduction

Authorization

The Conserver API provides a token based authentication, controlled by the environment variable CONSERVER_API_TOKEN in the environment. When not defined or empty, it is disabled. To enable, define CONSERVER_API_TOKEN in the .env file

vCon Management

Chain Management

Chains are series of links that process a vCon. Before processing a vCon, be sure to load it.

Configuration

Dead Letter Queue

Lifecyle

🧩

Search vCons based on various parameters

get

Search for vCons using personal identifiers and metadata.

Query parameters
telany ofOptional

Phone number to search for

stringOptional
or
nullOptional
mailtoany ofOptional

Email address to search for

stringOptional
or
nullOptional
nameany ofOptional

Name of the party to search for

stringOptional
or
nullOptional
Responses
get
GET /vcons/search HTTP/1.1
Host: 
Accept: */*

[
  {
    "uuid": "text",
    "created_at": "2025-04-29T17:37:03.683Z",
    "updated_at": "2025-04-29T17:37:03.683Z",
    "subject": "text",
    "parties": [
      {}
    ]
  }
]
  • Introduction
  • Authorization
  • vCon Management
  • GETGets a list of vCon UUIDs
  • POSTInserts a vCon into the database
  • GETGets a particular vCon by UUID
  • DELETEDeletes a particular vCon by UUID
  • GETSearch vCons based on various parameters
  • Chain Management
  • POSTInserts a vCon UUID into one or more chains
  • GETRemoves one or more vCon UUIDs from the output of a chain (egress)
  • GETReturns the number of vCons at the end of a chain
  • Configuration
  • GETReturns the config file for the conserver
  • POSTUpdates the config file for the conserver
  • DELETEClears the config file for the conserver
  • Dead Letter Queue
  • POSTReprocess the dead letter queue
  • GETGet Vcons list from the dead letter queue
  • Lifecyle
  • GETForces a reset of the vcon search list

Gets a list of vCon UUIDs

get

Enables pagination of vCon UUIDs. Use the page and size parameters to paginate the results. Can also filter by date with the since and until parameters.

Query parameters
pageintegerOptionalDefault: 1
sizeintegerOptionalDefault: 50
sincestring · date-timeOptional
untilstring · date-timeOptional
Responses
Responsestring[]
get

Gets a particular vCon by UUID

get

How to get a particular vCon by UUID

Path parameters
vcon_uuidstring · uuidRequired
Responses
get

Deletes a particular vCon by UUID

delete

How to remove a vCon from the conserver.

Path parameters
vcon_uuidstring · uuidRequired
Responses
delete
No content

Removes one or more vCon UUIDs from the output of a chain (egress)

get

Removes one or more vCon UUIDs from the output of a chain (egress)

Query parameters
egress_liststringRequired
limitanyOptionalDefault: 1
Responses
get
No content

Returns the number of vCons at the end of a chain

get

Returns the number of vCons at the end of a chain.

Query parameters
egress_liststringRequired
Responses
get
No content

Returns the config file for the conserver

get

Returns the config file for the conserver

Responses
Responseany
get
200

Successful Response

No content

Clears the config file for the conserver

delete

Clears the config file for the conserver

Responses
delete
204

Successful Response

No content

Reprocess the dead letter queue

post

Move the dead letter queue vcons back to the ingress chain

Query parameters
ingress_liststringRequired
Responses
Responseany
post
No content

Get Vcons list from the dead letter queue

get

Get Vcons list from the dead letter queue, returns array of vcons.

Query parameters
ingress_liststringRequired
Responses
Responseany
get
No content

Forces a reset of the vcon search list

get

Forces a reset of the vcon search list, returns the number of vCons indexed.

Responses
Responseany
get
200

Successful Response

No content
GET /vcon HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Inserts a vCon into the database

post

How to insert a vCon into the database.

Body
vconstringRequired
uuidstring · uuidRequired
created_atany ofRequired
integerOptional
or
stringOptional
or
string · date-timeOptional
subjectany ofOptional
stringOptional
or
nullOptional
redactedobject · RedactedOptionalDefault: {}
appendedany ofOptional
objectOptional
or
nullOptional
groupobject[]OptionalDefault: []
partiesobject[]OptionalDefault: []
dialogobject[]OptionalDefault: []
analysisobject[]OptionalDefault: []
attachmentsobject[]OptionalDefault: []
metaany ofOptionalDefault: {}
objectOptional
or
nullOptional
Responses
post
POST /vcon HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "vcon": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": 1,
  "subject": "text",
  "redacted": {},
  "appended": {},
  "group": [
    {}
  ],
  "parties": [
    {}
  ],
  "dialog": [
    {}
  ],
  "analysis": [
    {}
  ],
  "attachments": [
    {}
  ],
  "meta": {}
}
{
  "vcon": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": 1,
  "subject": "text",
  "redacted": {},
  "appended": {},
  "group": [
    {}
  ],
  "parties": [
    {}
  ],
  "dialog": [
    {}
  ],
  "analysis": [
    {}
  ],
  "attachments": [
    {}
  ],
  "meta": {}
}
GET /vcon/{vcon_uuid} HTTP/1.1
Host: 
Accept: */*

{
  "vcon": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": 1,
  "subject": "text",
  "redacted": {},
  "appended": {},
  "group": [
    {}
  ],
  "parties": [
    {}
  ],
  "dialog": [
    {}
  ],
  "analysis": [
    {}
  ],
  "attachments": [
    {}
  ],
  "meta": {}
}
DELETE /vcon/{vcon_uuid} HTTP/1.1
Host: 
Accept: */*

Inserts a vCon UUID into one or more chains

post

Inserts a vCon UUID into one or more chains.

Query parameters
ingress_liststringRequired
Body
string[]Optional
Responses
post
POST /vcon/ingress?ingress_list=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
No content
GET /vcon/egress?egress_list=text HTTP/1.1
Host: 
Accept: */*

GET /vcon/count?egress_list=text HTTP/1.1
Host: 
Accept: */*

GET /config HTTP/1.1
Host: 
Accept: */*

Updates the config file for the conserver

post

Updates the config file for the conserver

Query parameters
update_file_nameanyOptional
Body
object · ConfigOptional
Responses
post
POST /config HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
No content
DELETE /config HTTP/1.1
Host: 
Accept: */*

POST /dlq/reprocess?ingress_list=text HTTP/1.1
Host: 
Accept: */*

GET /dlq?ingress_list=text HTTP/1.1
Host: 
Accept: */*

GET /index_vcons HTTP/1.1
Host: 
Accept: */*