Skip to main content
GET
/
h
/
v2
/
agents
/
{agent_uid}
/
tools
List tools for an agent
curl --request GET \
  --url https://api.openmic.ai/h/v2/agents/{agent_uid}/tools \
  --header 'Authorization: Bearer <token>'
{
  "has_more": true,
  "tools": [
    {
      "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
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Path Parameters

​
agent_uid
string
required

The agent UID.

Query Parameters

​
page_size
integer

Number of records per page (default 50, max 100).

Required range: 1 <= x <= 100
​
cursor
string

Opaque pagination cursor returned by the previous response.

​
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
​
created_after
string<date-time>

Filter records created on or after this ISO 8601 timestamp.

​
created_before
string<date-time>

Filter records created on or before this ISO 8601 timestamp.

Response

Paginated list of tools.

​
has_more
boolean
required

Whether more records exist after this page.

​
tools
object[]
required
​
next_cursor
string

Opaque cursor to pass as cursor in the next request.