Skip to main content
POST
/
v2
/
agents
/
{agent_uid}
/
tools
Create a tool for an agent
curl --request POST \
  --url https://api.openmic.ai/v2/agents/{agent_uid}/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "api_request",
  "name": "lookup_order",
  "description": "Look up the status of a customer order.",
  "url": "https://api.yourapp.com/orders/status",
  "method": "post",
  "parameters": {
    "type": "object",
    "properties": {
      "order_id": {
        "type": "string"
      }
    },
    "required": [
      "order_id"
    ]
  },
  "speak_during_execution": true
}
'
import requests

url = "https://api.openmic.ai/v2/agents/{agent_uid}/tools"

payload = {
"type": "api_request",
"name": "lookup_order",
"description": "Look up the status of a customer order.",
"url": "https://api.yourapp.com/orders/status",
"method": "post",
"parameters": {
"type": "object",
"properties": { "order_id": { "type": "string" } },
"required": ["order_id"]
},
"speak_during_execution": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'api_request',
name: 'lookup_order',
description: 'Look up the status of a customer order.',
url: 'https://api.yourapp.com/orders/status',
method: 'post',
parameters: {
type: 'object',
properties: {order_id: {type: 'string'}},
required: ['order_id']
},
speak_during_execution: true
})
};

fetch('https://api.openmic.ai/v2/agents/{agent_uid}/tools', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openmic.ai/v2/agents/{agent_uid}/tools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'api_request',
'name' => 'lookup_order',
'description' => 'Look up the status of a customer order.',
'url' => 'https://api.yourapp.com/orders/status',
'method' => 'post',
'parameters' => [
'type' => 'object',
'properties' => [
'order_id' => [
'type' => 'string'
]
],
'required' => [
'order_id'
]
],
'speak_during_execution' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.openmic.ai/v2/agents/{agent_uid}/tools"

payload := strings.NewReader("{\n \"type\": \"api_request\",\n \"name\": \"lookup_order\",\n \"description\": \"Look up the status of a customer order.\",\n \"url\": \"https://api.yourapp.com/orders/status\",\n \"method\": \"post\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"speak_during_execution\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.openmic.ai/v2/agents/{agent_uid}/tools")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"api_request\",\n \"name\": \"lookup_order\",\n \"description\": \"Look up the status of a customer order.\",\n \"url\": \"https://api.yourapp.com/orders/status\",\n \"method\": \"post\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"speak_during_execution\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.openmic.ai/v2/agents/{agent_uid}/tools")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"api_request\",\n \"name\": \"lookup_order\",\n \"description\": \"Look up the status of a customer order.\",\n \"url\": \"https://api.yourapp.com/orders/status\",\n \"method\": \"post\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"speak_during_execution\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "url": "<string>",
  "api_timeout": 123,
  "parameters": {},
  "use_raw_schema": true,
  "static_params": {},
  "speak_during_execution": true,
  "speak_after_execution": true,
  "async": true
}
{
"error": "<string>",
"details": "<string>"
}
{
"error": "<string>",
"details": "<string>"
}
{
"success": true,
"message": "<string>",
"error": "<string>",
"retryAfter": 123
}
{
"error": "<string>",
"details": "<string>"
}

Authorizations

Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Path Parameters

agent_uid
string
required

The agent UID.

Body

application/json
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
Required string length: 1 - 255
description
string
url
string

Required when type is api_request.

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

Tool created.

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