Create Extraction Field
Create a data extraction field for an agent.
Extraction fields are structured values the AI pulls from each call transcript — an order number, a reported issue, a callback date.
Authorizations
Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.
Path Parameters
Tuner's internal numeric ID for the agent.
Workspace ID. Find this in Workspace > General Settings.
Body
Input schema for data extraction field.
Display name for this field, and the key it appears under on call records.
1 - 200Type of the extracted value: text, number, boolean, or enum. Use enum to restrict the value to a fixed set.
text, number, boolean, enum Instruction the AI uses to find this value in the transcript. Name what to look for and the form it takes.
1Allowed values, required when field_type is enum. Must be omitted otherwise — providing it with any other field_type returns a 422. Accepts an array or a comma-separated string.
Response
Successful Response
Response schema for data extraction field.
Unique identifier for the data extraction field.
42
Display name for this field, and the key it appears under on call records.
"Customer name"
Type of the extracted value: text, number, boolean, or enum. Use enum to restrict the value to a fixed set.
text, number, boolean, enum "text"
Instruction the AI uses to find this value in the transcript. Name what to look for and the form it takes.
"The full name the caller provides when asked to identify themselves."
Allowed values, present when field_type is enum and null otherwise, returned as a comma-separated string.
"Sales,Support,Billing"
Whether this field was added automatically as a system default. System fields cannot be modified or deleted.
false