Update an analyzer configuration

curl --request PUT \
  --url https://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "update_behavior": "automatic_update",
  "analysis_goals": "Extract the order number whenever the customer mentions it.",
  "example_values": "ORD-1001\\n9192 001023\\nTEST-ORDER-42"
}
'

import requests

url = "https://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}"

payload = {
    "update_behavior": "automatic_update",
    "analysis_goals": "Extract the order number whenever the customer mentions it.",
    "example_values": "ORD-1001\n9192 001023\nTEST-ORDER-42"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    update_behavior: 'automatic_update',
    analysis_goals: 'Extract the order number whenever the customer mentions it.',
    example_values: 'ORD-1001\n9192 001023\nTEST-ORDER-42'
  })
};

fetch('https://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}', 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://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'update_behavior' => 'automatic_update',
    'analysis_goals' => 'Extract the order number whenever the customer mentions it.',
    'example_values' => 'ORD-1001\\n9192 001023\\nTEST-ORDER-42'
  ]),
  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://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}"

	payload := strings.NewReader("{\n  \"update_behavior\": \"automatic_update\",\n  \"analysis_goals\": \"Extract the order number whenever the customer mentions it.\",\n  \"example_values\": \"ORD-1001\\\\n9192 001023\\\\nTEST-ORDER-42\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"update_behavior\": \"automatic_update\",\n  \"analysis_goals\": \"Extract the order number whenever the customer mentions it.\",\n  \"example_values\": \"ORD-1001\\\\n9192 001023\\\\nTEST-ORDER-42\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"update_behavior\": \"automatic_update\",\n  \"analysis_goals\": \"Extract the order number whenever the customer mentions it.\",\n  \"example_values\": \"ORD-1001\\\\n9192 001023\\\\nTEST-ORDER-42\"\n}"

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

Contact Analyzers

Update an analyzer configuration

Updates how one analyzer behaves. update_behavior controls what happens when the AI finds a value: dont_update ignores it, update_if_empty saves only if the field is empty, ask_approval_if_existing asks for approval when replacing an existing value, manual_approval always requires approval, and automatic_update saves automatically. analysis_goals explains what the AI should extract. example_values gives sample values for better extraction. For built-in b_* contact fields, only update_behavior can be changed. For pipeline analyzers, example_values is not used.

PUT

api

analyzers

{internal_id}

Update an analyzer configuration

curl --request PUT \
  --url https://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "update_behavior": "automatic_update",
  "analysis_goals": "Extract the order number whenever the customer mentions it.",
  "example_values": "ORD-1001\\n9192 001023\\nTEST-ORDER-42"
}
'

import requests

url = "https://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}"

payload = {
    "update_behavior": "automatic_update",
    "analysis_goals": "Extract the order number whenever the customer mentions it.",
    "example_values": "ORD-1001\n9192 001023\nTEST-ORDER-42"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    update_behavior: 'automatic_update',
    analysis_goals: 'Extract the order number whenever the customer mentions it.',
    example_values: 'ORD-1001\n9192 001023\nTEST-ORDER-42'
  })
};

fetch('https://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}', 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://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'update_behavior' => 'automatic_update',
    'analysis_goals' => 'Extract the order number whenever the customer mentions it.',
    'example_values' => 'ORD-1001\\n9192 001023\\nTEST-ORDER-42'
  ]),
  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://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}"

	payload := strings.NewReader("{\n  \"update_behavior\": \"automatic_update\",\n  \"analysis_goals\": \"Extract the order number whenever the customer mentions it.\",\n  \"example_values\": \"ORD-1001\\\\n9192 001023\\\\nTEST-ORDER-42\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"update_behavior\": \"automatic_update\",\n  \"analysis_goals\": \"Extract the order number whenever the customer mentions it.\",\n  \"example_values\": \"ORD-1001\\\\n9192 001023\\\\nTEST-ORDER-42\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/analyzers/{internal_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"update_behavior\": \"automatic_update\",\n  \"analysis_goals\": \"Extract the order number whenever the customer mentions it.\",\n  \"example_values\": \"ORD-1001\\\\n9192 001023\\\\nTEST-ORDER-42\"\n}"

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

Authorizations

Authorization

string

header

required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Path Parameters

internal_id

string

required

Analyzer identifier to update. Prefix meaning: b_ = built-in contact field, f_ = custom contact field, p_ = pipeline stage rule. Examples: f_order_number, p_initial_contact.

Body

application/json

update_behavior

enum<string>

How extracted values should be applied.

Available options:

dont_update,

update_if_empty,

ask_approval_if_existing,

manual_approval,

automatic_update

Example:

"automatic_update"

analysis_goals

string | null

Short instruction telling the AI what information to extract.

Maximum string length: 1000

Example:

"Extract the order number whenever the customer mentions it."

example_values

string | null

Optional sample values. Used for contact field analyzers; not used for pipeline analyzers.

Maximum string length: 1000

Example:

"ORD-1001\\n9192 001023\\nTEST-ORDER-42"

Response

Analyzer updated

Get a single analyzer Bulk update analyzers

API Documentation

API Reference

Update an analyzer configuration

Authorizations

Path Parameters

Body

Response