Skip to main content
PATCH
/
h
/
v2
/
agents
/
{agent_uid}
/
tools
/
{tool_id}
Update a tool
curl --request PATCH \
  --url https://api.openmic.ai/h/v2/agents/{agent_uid}/tools/{tool_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Updated description for the order lookup tool.",
  "speak_after_execution": true
}
'
{
  "id": 123,
  "type": "api_request",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "url": "<string>",
  "method": "get",
  "api_timeout": 123,
  "parameters": {},
  "use_raw_schema": true,
  "static_params": {},
  "speak_during_execution": true,
  "speak_after_execution": true,
  "async": true
}

Authorizations

​
Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Path Parameters

​
agent_uid
string
required
​
tool_id
integer
required

Numeric tool ID.

Body

application/json
​
type
enum<string>
Available options:
api_request,
function,
end_call,
transfer_call,
dtmf,
send_sms,
send_email,
call_booking,
check_calendar_availability,
check_working_hours
​
name
string
Required string length: 1 - 255
​
description
string
​
url
string
​
method
enum<string>
Available options:
get,
post
​
api_timeout
integer
​
parameters
object
​
use_raw_schema
boolean
​
static_params
object
​
speak_during_execution
boolean
​
speak_after_execution
boolean
​
async
boolean

Response

Updated tool.

​
id
integer
required
​
type
enum<string>
required
Available options:
api_request,
function,
end_call,
transfer_call,
dtmf,
send_sms,
send_email,
call_booking,
check_calendar_availability,
check_working_hours
​
name
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string
​
url
string

Required when type is api_request.

​
method
enum<string>
Available options:
get,
post
​
api_timeout
integer
​
parameters
object

JSON Schema object describing the tool parameters.

​
use_raw_schema
boolean
​
static_params
object
​
speak_during_execution
boolean
​
speak_after_execution
boolean
​
async
boolean