Skip to main content
PATCH
Update a tool

Authorizations

Authorization
string
header
required

Secret API key (omic_...) obtained from the OpenMic dashboard. The public key (omic_pub_...) is only accepted by /whoami, /create-web-call, and the agent test-call endpoints; every other endpoint rejects it with 403 This endpoint requires a private API key.

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