OPopenmicai
Tools

Create a tool for an agent

Changed on

Adds a new tool to the agent's toolset.

When type is api_request, the url field is required.

post/v2/agents/{agent_uid}/tools

Request

  • Base URL
    https://api.openmic.ai
  • URL
    https://api.openmic.ai/v2/agents/{agent_uid}/tools
  • Auth
    HTTP bearer

Request body

type'api_request' | 'function' | 'end_call' | 'transfer_call' | 'dtmf' | 'send_sms' | 'send_email' | 'call_booking' | 'check_calendar_availability' | 'check_working_hours' required
namestring required
descriptionstring
urlstring

Required when type is api_request.

method'get' | 'post'
api_timeoutinteger
parametersobject
use_raw_schemaboolean
static_paramsobject
speak_during_executionboolean
speak_after_executionboolean
asyncboolean

Response

Tool created.

idinteger required
type'api_request' | 'function' | 'end_call' | 'transfer_call' | 'dtmf' | 'send_sms' | 'send_email' | 'call_booking' | 'check_calendar_availability' | 'check_working_hours' required
namestring required
descriptionstring
urlstring

Required when type is api_request.

method'get' | 'post'
api_timeoutinteger
parametersobject

JSON Schema object describing the tool parameters.

use_raw_schemaboolean
static_paramsobject
speak_during_executionboolean
speak_after_executionboolean
asyncboolean
created_atstring date-time required
updated_atstring date-time required

Changes