Compare two versions

GET

agents

{agent_id}

compare

Compare Versions

curl --request GET \
  --url https://api.vocily.ai/v1/agents/{agent_id}/compare \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vocily.ai/v1/agents/{agent_id}/compare', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vocily.ai/v1/agents/{agent_id}/compare",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vocily.ai/v1/agents/{agent_id}/compare"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vocily.ai/v1/agents/{agent_id}/compare")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "left": {
    "version": 0,
    "version_id": "00000006-0000-4000-8000-000000000006",
    "is_published": true,
    "is_live": true,
    "label": "Renamed",
    "notes": null,
    "base_version": null,
    "document_revision": 2,
    "blocked_reasons": [],
    "inbound_phone": null,
    "inbound_whatsapp": null,
    "created_at": "2026-09-16T19:38:03.767024Z",
    "published_at": "2026-09-16T19:38:03.999783Z"
  },
  "right": {
    "version": 1,
    "version_id": "0000000a-0000-4000-8000-00000000000a",
    "is_published": false,
    "is_live": false,
    "label": null,
    "notes": null,
    "base_version": 0,
    "document_revision": 2,
    "blocked_reasons": [],
    "inbound_phone": null,
    "inbound_whatsapp": null,
    "created_at": "2026-09-16T19:38:04.059129Z",
    "published_at": null
  },
  "differences": [
    {
      "field": "call.max_duration_minutes",
      "change": "changed",
      "before": 5,
      "after": 9
    }
  ]
}

{
  "detail": "Invalid API key",
  "code": "UNAUTHORIZED"
}

{
  "detail": {
    "code": "validation_error",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "message": "<string>",
        "type": "<string>"
      }
    ]
  },
  "code": "VALIDATION_ERROR"
}

{
  "code": "rate_limited"
}

GET /v1/agents/{agent_id}/compare?left=4&right=7

Any pair — not only draft against live. Each difference names the field as this API names it, so you can act on it directly:

{ "differences": [
  { "field": "voice.speed", "change": "changed", "before": 1.0, "after": 1.3 },
  { "field": "builtin_tools.transfer_call.numbers[0].number", "change": "changed", "before": "+919876543210", "after": "+919876500000" }
] }

Compares configuration only. Labels, timestamps and version numbers are not differences in how the agent behaves, and neither are the agent’s tools — those are a dashboard surface, so a difference never names a field you cannot read or write here.

Authorizations

Authorization

string

header

required

Your API key as a Bearer token, e.g. Authorization: Bearer vk_….

Path Parameters

agent_id

string

required

The agent's id, as GET /v1/agents returns it.

Query Parameters

left

string

required

version number, e.g. 3

right

string

required

version number, e.g. 4

Response

What differs between the two versions, named in this API's own fields.

left

PublicVersionSummary · object

required

The first version of the pair.

Show child attributes

right

PublicVersionSummary · object

required

The second version of the pair.

Show child attributes

differences

VersionDiff · object[]

Every configuration field that differs, in PUBLIC field paths — the same paths you send on a PATCH. Metadata (labels, timestamps, version numbers) is excluded: it always differs and says nothing about behaviour.

Show child attributes

Compare Versions

curl --request GET \
  --url https://api.vocily.ai/v1/agents/{agent_id}/compare \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vocily.ai/v1/agents/{agent_id}/compare', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vocily.ai/v1/agents/{agent_id}/compare",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vocily.ai/v1/agents/{agent_id}/compare"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vocily.ai/v1/agents/{agent_id}/compare")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "left": {
    "version": 0,
    "version_id": "00000006-0000-4000-8000-000000000006",
    "is_published": true,
    "is_live": true,
    "label": "Renamed",
    "notes": null,
    "base_version": null,
    "document_revision": 2,
    "blocked_reasons": [],
    "inbound_phone": null,
    "inbound_whatsapp": null,
    "created_at": "2026-09-16T19:38:03.767024Z",
    "published_at": "2026-09-16T19:38:03.999783Z"
  },
  "right": {
    "version": 1,
    "version_id": "0000000a-0000-4000-8000-00000000000a",
    "is_published": false,
    "is_live": false,
    "label": null,
    "notes": null,
    "base_version": 0,
    "document_revision": 2,
    "blocked_reasons": [],
    "inbound_phone": null,
    "inbound_whatsapp": null,
    "created_at": "2026-09-16T19:38:04.059129Z",
    "published_at": null
  },
  "differences": [
    {
      "field": "call.max_duration_minutes",
      "change": "changed",
      "before": 5,
      "after": 9
    }
  ]
}

{
  "detail": "Invalid API key",
  "code": "UNAUTHORIZED"
}

{
  "detail": {
    "code": "validation_error",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "message": "<string>",
        "type": "<string>"
      }
    ]
  },
  "code": "VALIDATION_ERROR"
}

{
  "code": "rate_limited"
}

Calls

Chats

Phone Numbers

Knowledge Bases

Files

Agents

Speech

Catalogues

Integrations

Custom Analysis

Memory

Widget

Webhooks

Compare two versions

Authorizations

Path Parameters

Query Parameters

Response