Edit an item
Change what one item extracts, or how.
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.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.
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
Your API key as a Bearer token, e.g. Authorization: Bearer vk_….
Path Parameters
The analysis item's id, from GET /v1/custom-analysis.
Body
What to call this value. Renaming changes the key it arrives under on every future call.
1 - 255The instruction the model reads. Tightening it is how you fix a bad extraction.
1regex pulls the value out by pattern and costs nothing; anything else asks the model.
8The shape of the value. Changing it changes the shape on every future call; past calls keep what they were analysed with.
16Whether the model must produce a value.
Limits on the value. Narrowing an enum can leave older rows holding values no longer in the list.
The inner fields, for an object or array value.
Turn it off without deleting it.
Response
The updated item.
string, number, integer, boolean, array, object ai, regex