Update an intent

Updates a custom intent. Use this to change trigger wording, confidence threshold, webhook target, response handling, or collected parameters. If parameters is included, it replaces the full parameter list. System intents cannot be modified.

PATCH /api/v1/agents/{uuid}/intents/{intentUuid}

Update an intent

cURL

curl --request PATCH \
  --url https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/intents/{intentUuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Book Appointment",
  "key": "<string>",
  "description": "<string>",
  "recommendation_actions": "<string>",
  "confidence_threshold": 0.7,
  "intent_llm_handle_by_response": true,
  "webhook": {
    "url": "<string>",
    "auth_token": "<string>"
  },
  "parameters": [
    {
      "key": "email",
      "default": "<string>",
      "type": "string",
      "required": true
    }
  ]
}
'

import requests

url = "https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/intents/{intentUuid}"

payload = {
    "name": "Book Appointment",
    "key": "<string>",
    "description": "<string>",
    "recommendation_actions": "<string>",
    "confidence_threshold": 0.7,
    "intent_llm_handle_by_response": True,
    "webhook": {
        "url": "<string>",
        "auth_token": "<string>"
    },
    "parameters": [
        {
            "key": "email",
            "default": "<string>",
            "type": "string",
            "required": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Book Appointment',
    key: '<string>',
    description: '<string>',
    recommendation_actions: '<string>',
    confidence_threshold: 0.7,
    intent_llm_handle_by_response: true,
    webhook: {url: '<string>', auth_token: '<string>'},
    parameters: [{key: 'email', default: '<string>', type: 'string', required: true}]
  })
};

fetch('https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/intents/{intentUuid}', 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/agents/{uuid}/intents/{intentUuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Book Appointment',
    'key' => '<string>',
    'description' => '<string>',
    'recommendation_actions' => '<string>',
    'confidence_threshold' => 0.7,
    'intent_llm_handle_by_response' => true,
    'webhook' => [
        'url' => '<string>',
        'auth_token' => '<string>'
    ],
    'parameters' => [
        [
                'key' => 'email',
                'default' => '<string>',
                'type' => 'string',
                'required' => true
        ]
    ]
  ]),
  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/agents/{uuid}/intents/{intentUuid}"

	payload := strings.NewReader("{\n  \"name\": \"Book Appointment\",\n  \"key\": \"<string>\",\n  \"description\": \"<string>\",\n  \"recommendation_actions\": \"<string>\",\n  \"confidence_threshold\": 0.7,\n  \"intent_llm_handle_by_response\": true,\n  \"webhook\": {\n    \"url\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"parameters\": [\n    {\n      \"key\": \"email\",\n      \"default\": \"<string>\",\n      \"type\": \"string\",\n      \"required\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/intents/{intentUuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Book Appointment\",\n  \"key\": \"<string>\",\n  \"description\": \"<string>\",\n  \"recommendation_actions\": \"<string>\",\n  \"confidence_threshold\": 0.7,\n  \"intent_llm_handle_by_response\": true,\n  \"webhook\": {\n    \"url\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"parameters\": [\n    {\n      \"key\": \"email\",\n      \"default\": \"<string>\",\n      \"type\": \"string\",\n      \"required\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/intents/{intentUuid}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Book Appointment\",\n  \"key\": \"<string>\",\n  \"description\": \"<string>\",\n  \"recommendation_actions\": \"<string>\",\n  \"confidence_threshold\": 0.7,\n  \"intent_llm_handle_by_response\": true,\n  \"webhook\": {\n    \"url\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"parameters\": [\n    {\n      \"key\": \"email\",\n      \"default\": \"<string>\",\n      \"type\": \"string\",\n      \"required\": true\n    }\n  ]\n}"

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

200

{
  "success": true,
  "data": {
    "intent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "<string>",
    "name": "<string>",
    "description": "<string>",
    "recommendation_actions": "<string>",
    "confidence_threshold": 123,
    "is_system": true,
    "intent_llm_handle_by_response": true,
    "webhook": {
      "url": "<string>",
      "auth_token": "<string>"
    },
    "parameters": [
      {
        "key": "email",
        "default": "<string>",
        "type": "string",
        "required": true
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

uuid · string<uuid> · required

intentUuid · string<uuid> · required

Body

application/json

name · string · required

Example:

"Book Appointment"

key · string | null

Auto-generated from name when omitted (e.g. 'book_appointment')

description · string | null

When this intent should trigger

recommendation_actions · string | null

confidence_threshold · number<float>

Example:

0.7

intent_llm_handle_by_response · boolean

webhook · object

Show child attributes

parameters · object[]

Show child attributes

Response

200

application/json

Intent updated

success · boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

data · object

Show child attributes