Skip to main content

AgentHumanClarificationConfig

Persisted settings for escalating an unresolved client question to a human manager.

enabledEnabled

Whether the agent may defer a dialogue and ask a human manager for help.

Default value: false
channel_id object

Manager-facing destination chat/channel for clarification notifications.

anyOf
string
message_thread_id object

Optional thread or topic inside the manager channel.

anyOf
string
timeout_secondsTimeout Seconds

How long the clarification may stay pending before expiring.

Possible values: >= 1

Default value: 14400
extra_text object

Optional extra static text appended to the manager notification.

anyOf
string
follow_up_enabledFollow Up Enabled

Whether the client-facing waiting message is sent after the manager notification succeeds.

Default value: true
follow_up_message_source object

Optional source of the client-facing waiting message. Literal content (text, prepared_message_id, waba_template_id, files) is sent as-is; a source with only prompt_id generates the message with that prompt; when unset, the message is generated with a built-in prompt.

anyOf
text object
anyOf
string
prompt_id object
anyOf
integer
prompt_version_id object
anyOf
integer
prepared_message_id object
anyOf
integer
waba_template_id object
anyOf
integer
file_idsinteger[]
caption object
anyOf
string
timeout_follow_up_message_source object
anyOf
text object
anyOf
string
prompt_id object
anyOf
integer
prompt_version_id object
anyOf
integer
prepared_message_id object
anyOf
integer
waba_template_id object
anyOf
integer
file_idsinteger[]
caption object
anyOf
string
lead_field_namesstring[]

Ordered lead CRM field keys that should be snapshotted into each clarification.

gate_modeHitlGateMode

How the pre-reply clarification gate participates. With enforce (default), a separate classifier decides per client message whether the agent may ask the manager, and the agent's clarification prompt is applied as that classifier's policy instead of as main-prompt instructions. With shadow, the classifier runs and its verdicts are logged, but nothing changes for the agent. With off, the classifier does not run. Automatic re-runs (dialogue resumer, pings) never ask the manager, in any mode.

Possible values: [off, shadow, enforce]

Default value: enforce
gate_arming_labelsHitlGateLabel[]

Gate verdict labels that let the agent ask the manager when gate_mode is enforce. Defaults to needs_manager_fact and likely_needs_manager_fact; narrow to needs_manager_fact alone for the strictest gating.

Possible values: [needs_manager_fact, likely_needs_manager_fact, answerable_or_clarify, out_of_scope, background_turn, gate_error]

max_clarifications_per_day object

Maximum manager-reaching clarification attempts per dialogue per rolling 24 hours (default 3). Over the limit the agent answers from available knowledge instead of asking the manager. Null removes the limit.

anyOf
integer

Possible values: >= 1

AgentHumanClarificationConfig
{
"enabled": false,
"channel_id": "string",
"message_thread_id": "string",
"timeout_seconds": 14400,
"extra_text": "string",
"follow_up_enabled": true,
"follow_up_message_source": {
"text": "string",
"prompt_id": 0,
"prompt_version_id": 0,
"prepared_message_id": 0,
"waba_template_id": 0,
"file_ids": [
0
],
"caption": "string"
},
"timeout_follow_up_message_source": {
"text": "string",
"prompt_id": 0,
"prompt_version_id": 0,
"prepared_message_id": 0,
"waba_template_id": 0,
"file_ids": [
0
],
"caption": "string"
},
"lead_field_names": [
"string"
],
"gate_mode": "enforce",
"gate_arming_labels": [
"needs_manager_fact"
],
"max_clarifications_per_day": 0
}