Skip to main content
PATCH
/
v1
/
bots
/
{bot_uid}
/
tools
/
{tool_id}
Update Tool
curl --request PATCH \
  --url https://api.openmic.ai/v1/bots/{bot_uid}/tools/{tool_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "url": "<string>",
  "api_timeout": 2,
  "parameters": {},
  "use_raw_schema": true,
  "static_params": {},
  "speak_during_execution": true,
  "speak_after_execution": true,
  "async": true
}
'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "url": "<string>",
  "method": "<string>",
  "api_timeout": 123,
  "parameters": {},
  "use_raw_schema": true,
  "static_params": {},
  "speak_during_execution": true,
  "speak_after_execution": true,
  "async": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as: Authorization: Bearer <your-api-key>

Path Parameters

​
bot_uid
string
required

The unique identifier of the bot.

​
tool_id
integer
required

The numeric ID of the tool.

Body

application/json
​
type
enum<string>

The type of tool that determines its behavior and required configuration.

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

Response

Updated tool.

​
id
integer

Unique numeric ID of the tool.

​
type
enum<string>

The type of tool that determines its behavior and required configuration.

Available options:
api_request,
function,
end_call,
transfer_call,
dtmf,
send_sms,
send_email,
call_booking,
check_calendar_availability,
check_working_hours
​
name
string
​
description
string
​
url
string
​
method
string
​
api_timeout
integer
​
parameters
object
​
use_raw_schema
boolean
​
static_params
object
​
speak_during_execution
boolean
​
speak_after_execution
boolean
​
async
boolean
​
created_at
string<date-time>
​
updated_at
string<date-time>