Skip to main content
Update Custom Analysis Item
description is the instruction the model reads, not a label. Editing it is how you fix bad extractions — tighten the direction rather than renaming the field.
Changing result_format or constraints changes the shape of the value on every future call. Past calls keep whatever they were analysed with, so a consumer reading a warehouse column across a format change will see both shapes — narrow an enum and older rows may hold values no longer in the list.
Built-in values are only partly editable. On an item Vocily ships, you may change description and enabled. name, result_format and constraints are refused with 409: the name is the key on the call payload, and the sentiment filter’s enum is built from the format and constraints, so readers elsewhere assume them. The description — what the model is actually told — is the part worth tuning, and is why these live here at all.
Renaming an item has the same consequence as renaming a group: the name is part of the key on the call payload, custom_analysis["Lead QA"]["Lead Temperature"].

Authorizations

Authorization
string
header
required

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

Path Parameters

item_id
string
required

The analysis item's id, from GET /v1/custom-analysis.

Body

application/json
name
string | null

What to call this value. Renaming changes the key it arrives under on every future call.

Required string length: 1 - 255
description
string | null

The instruction the model reads. Tightening it is how you fix a bad extraction.

Minimum string length: 1
extraction_method
string | null

regex pulls the value out by pattern and costs nothing; anything else asks the model.

Maximum string length: 8
result_format
string | null

The shape of the value. Changing it changes the shape on every future call; past calls keep what they were analysed with.

Maximum string length: 16
required
boolean | null

Whether the model must produce a value.

constraints
CustomAnalysisConstraints · object | null

Limits on the value. Narrowing an enum can leave older rows holding values no longer in the list.

fields
CustomAnalysisFieldSpec · object[] | null

The inner fields, for an object or array value.

enabled
boolean | null

Turn it off without deleting it.

Response

The updated item.

id
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>