🧩API
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
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.
150Successful Response
Validation Error
GET /vcon HTTP/1.1
Host:
Accept: */*
[
"text"
]How to insert a vCon into the database.
{}[][][][][]{}Successful Response
Validation Error
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": {}
}How to get a particular vCon by UUID
Successful Response
Validation Error
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": {}
}Search for vCons using personal identifiers and metadata.
Phone number to search for
Email address to search for
Name of the party to search for
Successful Response
Validation Error
GET /vcons/search HTTP/1.1
Host:
Accept: */*
[
{
"uuid": "text",
"created_at": "2025-08-21T20:16:54.665Z",
"updated_at": "2025-08-21T20:16:54.665Z",
"subject": "text",
"parties": [
{}
]
}
]Chain Management
Chains are series of links that process a vCon. Before processing a vCon, be sure to load it.
Inserts a vCon UUID into one or more chains.
Successful Response
Validation Error
POST /vcon/ingress?ingress_list=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 8
[
"text"
]No content
Removes one or more vCon UUIDs from the output of a chain (egress)
1Successful Response
Validation Error
GET /vcon/egress?egress_list=text HTTP/1.1
Host:
Accept: */*
No content
Configuration
Updates the config file for the conserver
Successful Response
Validation Error
POST /config HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 2
{}No content
Dead Letter Queue
Move the dead letter queue vcons back to the ingress chain
Successful Response
Validation Error
POST /dlq/reprocess?ingress_list=text HTTP/1.1
Host:
Accept: */*
No content
Get Vcons list from the dead letter queue, returns array of vcons.
Successful Response
Validation Error
GET /dlq?ingress_list=text HTTP/1.1
Host:
Accept: */*
No content
Lifecyle
Last updated
Was this helpful?