Add an item

POST

custom-analysis

items

Create Custom Analysis Item

curl --request POST \
  --url https://api.vocily.ai/v1/custom-analysis/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category_id": "1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d",
  "name": "Lead Temperature",
  "description": "How ready the caller is to buy, from what they said.",
  "result_format": "string",
  "constraints": {
    "enum": [
      "hot",
      "warm",
      "cold"
    ]
  }
}
'

import requests

url = "https://api.vocily.ai/v1/custom-analysis/items"

payload = {
    "category_id": "1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d",
    "name": "Lead Temperature",
    "description": "How ready the caller is to buy, from what they said.",
    "result_format": "string",
    "constraints": { "enum": ["hot", "warm", "cold"] }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    category_id: '1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d',
    name: 'Lead Temperature',
    description: 'How ready the caller is to buy, from what they said.',
    result_format: 'string',
    constraints: {enum: ['hot', 'warm', 'cold']}
  })
};

fetch('https://api.vocily.ai/v1/custom-analysis/items', 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/custom-analysis/items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'category_id' => '1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d',
    'name' => 'Lead Temperature',
    'description' => 'How ready the caller is to buy, from what they said.',
    'result_format' => 'string',
    'constraints' => [
        'enum' => [
                'hot',
                'warm',
                'cold'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.vocily.ai/v1/custom-analysis/items"

	payload := strings.NewReader("{\n  \"category_id\": \"1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d\",\n  \"name\": \"Lead Temperature\",\n  \"description\": \"How ready the caller is to buy, from what they said.\",\n  \"result_format\": \"string\",\n  \"constraints\": {\n    \"enum\": [\n      \"hot\",\n      \"warm\",\n      \"cold\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vocily.ai/v1/custom-analysis/items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"category_id\": \"1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d\",\n  \"name\": \"Lead Temperature\",\n  \"description\": \"How ready the caller is to buy, from what they said.\",\n  \"result_format\": \"string\",\n  \"constraints\": {\n    \"enum\": [\n      \"hot\",\n      \"warm\",\n      \"cold\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocily.ai/v1/custom-analysis/items")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"category_id\": \"1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d\",\n  \"name\": \"Lead Temperature\",\n  \"description\": \"How ready the caller is to buy, from what they said.\",\n  \"result_format\": \"string\",\n  \"constraints\": {\n    \"enum\": [\n      \"hot\",\n      \"warm\",\n      \"cold\"\n    ]\n  }\n}"

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

{
  "name": "Lead Temperature",
  "description": "How ready the caller is to buy.",
  "extraction_method": "ai",
  "result_format": "string",
  "required": false,
  "constraints": {
    "enum": [
      "hot",
      "warm"
    ]
  },
  "fields": [],
  "enabled": true,
  "id": "00000010-0000-4000-8000-000000000010",
  "category_id": "0000000f-0000-4000-8000-00000000000f",
  "is_system": false,
  "created_at": "2026-09-16T19:38:04.238748Z",
  "updated_at": "2026-09-16T19:38:04.238748Z"
}

{
  "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"
}

{ "category_id": "…",
  "name": "Lead Temperature",
  "description": "How ready the caller is to buy, from what they said.",
  "result_format": "string",
  "constraints": { "enum": ["hot", "warm", "cold"] } }

description is the instruction, not a label. It is what the model is told to look for, so write it as a direction rather than a title.

`result_format`	For
`string`	Free text — or a fixed set, with `constraints.enum`
`number` · `integer`	Quantities, with `minimum` / `maximum`
`boolean`	Yes or no
`array` · `object`	Lists and records, shaped by `constraints`

Set extraction_method: "regex" with constraints.pattern to pull a value out by pattern instead of by model. Regex items cost nothing, and a group made only of them makes no model call at all. The extracted values arrive on the call: custom_analysis["Lead QA"]["Lead Temperature"].

Authorizations

Authorization

string

header

required

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

Body

application/json

name

string

required

What to call this value. Part of the key it arrives under — custom_analysis["Lead QA"]["Lead Temperature"].

Required string length: 1 - 255

description

string

required

The instruction the model reads, not a label. Write it as a direction — what to look for — rather than a title.

Minimum string length: 1

result_format

string

required

The shape of the value: string, number, integer, boolean, array or object.

Maximum string length: 16

category_id

string

required

Which group this value belongs to, from GET /v1/custom-analysis.

extraction_method

string

default:ai

regex pulls the value out by pattern using constraints.pattern and costs nothing; anything else asks the model. A group made only of regex items makes no model call at all.

Maximum string length: 8

required

boolean

default:false

Whether the model must produce a value rather than leaving it out.

constraints

CustomAnalysisConstraints · object

Limits on the value — a fixed set with enum, a range, a regex, a length.

Show child attributes

fields

CustomAnalysisFieldSpec · object[]

The inner fields, when result_format is object or array.

Show child attributes

enabled

boolean

default:true

Turn it off without deleting it.

Response

The created item.

string

category_id

string

name

string

description

string

result_format

enum<string>

Available options:

string,

number,

integer,

boolean,

array,

object

extraction_method

enum<string>

Available options:

ai,

regex

required

boolean

constraints

object

fields

object[]

enabled

boolean

is_system

boolean

created_at

string<date-time>

updated_at

string<date-time>

Create Custom Analysis Item

curl --request POST \
  --url https://api.vocily.ai/v1/custom-analysis/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category_id": "1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d",
  "name": "Lead Temperature",
  "description": "How ready the caller is to buy, from what they said.",
  "result_format": "string",
  "constraints": {
    "enum": [
      "hot",
      "warm",
      "cold"
    ]
  }
}
'

import requests

url = "https://api.vocily.ai/v1/custom-analysis/items"

payload = {
    "category_id": "1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d",
    "name": "Lead Temperature",
    "description": "How ready the caller is to buy, from what they said.",
    "result_format": "string",
    "constraints": { "enum": ["hot", "warm", "cold"] }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    category_id: '1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d',
    name: 'Lead Temperature',
    description: 'How ready the caller is to buy, from what they said.',
    result_format: 'string',
    constraints: {enum: ['hot', 'warm', 'cold']}
  })
};

fetch('https://api.vocily.ai/v1/custom-analysis/items', 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/custom-analysis/items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'category_id' => '1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d',
    'name' => 'Lead Temperature',
    'description' => 'How ready the caller is to buy, from what they said.',
    'result_format' => 'string',
    'constraints' => [
        'enum' => [
                'hot',
                'warm',
                'cold'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.vocily.ai/v1/custom-analysis/items"

	payload := strings.NewReader("{\n  \"category_id\": \"1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d\",\n  \"name\": \"Lead Temperature\",\n  \"description\": \"How ready the caller is to buy, from what they said.\",\n  \"result_format\": \"string\",\n  \"constraints\": {\n    \"enum\": [\n      \"hot\",\n      \"warm\",\n      \"cold\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vocily.ai/v1/custom-analysis/items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"category_id\": \"1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d\",\n  \"name\": \"Lead Temperature\",\n  \"description\": \"How ready the caller is to buy, from what they said.\",\n  \"result_format\": \"string\",\n  \"constraints\": {\n    \"enum\": [\n      \"hot\",\n      \"warm\",\n      \"cold\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocily.ai/v1/custom-analysis/items")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"category_id\": \"1f7a2c3e-9b40-4d2a-8c11-5e6f7a8b9c0d\",\n  \"name\": \"Lead Temperature\",\n  \"description\": \"How ready the caller is to buy, from what they said.\",\n  \"result_format\": \"string\",\n  \"constraints\": {\n    \"enum\": [\n      \"hot\",\n      \"warm\",\n      \"cold\"\n    ]\n  }\n}"

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

{
  "name": "Lead Temperature",
  "description": "How ready the caller is to buy.",
  "extraction_method": "ai",
  "result_format": "string",
  "required": false,
  "constraints": {
    "enum": [
      "hot",
      "warm"
    ]
  },
  "fields": [],
  "enabled": true,
  "id": "00000010-0000-4000-8000-000000000010",
  "category_id": "0000000f-0000-4000-8000-00000000000f",
  "is_system": false,
  "created_at": "2026-09-16T19:38:04.238748Z",
  "updated_at": "2026-09-16T19:38:04.238748Z"
}

{
  "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

Authorizations

Body

Response