Skip to main content
GET
/
v1
/
bots
/
{bot_uid}
/
tools
List Tools
curl --request GET \
  --url https://api.openmic.ai/v1/bots/{bot_uid}/tools \
  --header 'Authorization: Bearer <token>'
{
  "tools": [
    {
      "id": 123,
      "type": "api_request",
      "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"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "has_more": true
  }
}

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.

Query Parameters

​
limit
integer
default:50

Max tools to return (1-100).

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of tools to skip.

Required range: x >= 0
​
type
enum<string>

Filter by tool type. 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
​
created_after
string<date-time>

Filter tools created after this date.

​
created_before
string<date-time>

Filter tools created before this date.

Response

Paginated list of tools.

​
tools
object[]
​
pagination
object