Create Tool
curl --request POST \
--url https://api.example.com/api/toolsimport requests
url = "https://api.example.com/api/tools"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/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.example.com/api/tools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/tools"
req, _ := http.NewRequest("POST", url, nil)
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.example.com/api/tools")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyTools
Create Tool
Create a new tool
POST
/
api
/
tools
Create Tool
curl --request POST \
--url https://api.example.com/api/toolsimport requests
url = "https://api.example.com/api/tools"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/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.example.com/api/tools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/tools"
req, _ := http.NewRequest("POST", url, nil)
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.example.com/api/tools")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyRequest
curl -X POST https://app.orova.ai/api/tools \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Check Order Status",
"type": "http",
"description": "Use when the caller asks about their order status",
"workspaceId": "WORKSPACE_ID",
"config": {
"method": "GET",
"url": "https://api.yourcompany.com/orders/{order_id}",
"headers": {
"Authorization": "Bearer YOUR_BACKEND_TOKEN"
}
},
"parameters": [
{
"name": "order_id",
"description": "The customer order number",
"required": true
}
]
}'
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Tool display name |
type | string | Yes | Tool type: http, integration, or transfer |
description | string | Yes | Tells the agent when to use this tool |
workspaceId | string | Yes | Workspace ID |
templateId | string | No | Integration template ID (for integration tools) |
config | object | No | HTTP config: method, url, headers, body |
parameters | array | No | Parameters the agent extracts from the conversation |
Response
{
"_id": "tool_abc123",
"name": "Check Order Status",
"type": "http",
"description": "Use when the caller asks about their order status",
"workspaceId": "WORKSPACE_ID",
"config": {
"method": "GET",
"url": "https://api.yourcompany.com/orders/{order_id}"
},
"createdAt": "2025-01-01T00:00:00.000Z"
}
Was this page helpful?
⌘I

