Create Tool
curl --request POST \
--url https://api.example.com/api/v1/tools \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"definition": {
"type": "http_api",
"config": {
"method": "<string>",
"url": "<string>",
"headers": {},
"credential_uuid": "<string>",
"parameters": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>",
"required": true
}
],
"timeout_ms": 5000,
"trigger_phrases": [
"<string>"
],
"wait_message": "<string>",
"response_fields": [
"<string>"
],
"error_message": "<string>",
"template_id": "<string>"
},
"schema_version": 1
},
"description": "<string>",
"category": "http_api",
"icon": "globe",
"icon_color": "#3B82F6"
}
'import requests
url = "https://api.example.com/api/v1/tools"
payload = {
"name": "<string>",
"definition": {
"type": "http_api",
"config": {
"method": "<string>",
"url": "<string>",
"headers": {},
"credential_uuid": "<string>",
"parameters": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>",
"required": True
}
],
"timeout_ms": 5000,
"trigger_phrases": ["<string>"],
"wait_message": "<string>",
"response_fields": ["<string>"],
"error_message": "<string>",
"template_id": "<string>"
},
"schema_version": 1
},
"description": "<string>",
"category": "http_api",
"icon": "globe",
"icon_color": "#3B82F6"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
definition: {
type: 'http_api',
config: {
method: '<string>',
url: '<string>',
headers: {},
credential_uuid: '<string>',
parameters: [{name: '<string>', type: '<string>', description: '<string>', required: true}],
timeout_ms: 5000,
trigger_phrases: ['<string>'],
wait_message: '<string>',
response_fields: ['<string>'],
error_message: '<string>',
template_id: '<string>'
},
schema_version: 1
},
description: '<string>',
category: 'http_api',
icon: 'globe',
icon_color: '#3B82F6'
})
};
fetch('https://api.example.com/api/v1/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/v1/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([
'name' => '<string>',
'definition' => [
'type' => 'http_api',
'config' => [
'method' => '<string>',
'url' => '<string>',
'headers' => [
],
'credential_uuid' => '<string>',
'parameters' => [
[
'name' => '<string>',
'type' => '<string>',
'description' => '<string>',
'required' => true
]
],
'timeout_ms' => 5000,
'trigger_phrases' => [
'<string>'
],
'wait_message' => '<string>',
'response_fields' => [
'<string>'
],
'error_message' => '<string>',
'template_id' => '<string>'
],
'schema_version' => 1
],
'description' => '<string>',
'category' => 'http_api',
'icon' => 'globe',
'icon_color' => '#3B82F6'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.example.com/api/v1/tools"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"definition\": {\n \"type\": \"http_api\",\n \"config\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {},\n \"credential_uuid\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"timeout_ms\": 5000,\n \"trigger_phrases\": [\n \"<string>\"\n ],\n \"wait_message\": \"<string>\",\n \"response_fields\": [\n \"<string>\"\n ],\n \"error_message\": \"<string>\",\n \"template_id\": \"<string>\"\n },\n \"schema_version\": 1\n },\n \"description\": \"<string>\",\n \"category\": \"http_api\",\n \"icon\": \"globe\",\n \"icon_color\": \"#3B82F6\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.example.com/api/v1/tools")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"definition\": {\n \"type\": \"http_api\",\n \"config\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {},\n \"credential_uuid\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"timeout_ms\": 5000,\n \"trigger_phrases\": [\n \"<string>\"\n ],\n \"wait_message\": \"<string>\",\n \"response_fields\": [\n \"<string>\"\n ],\n \"error_message\": \"<string>\",\n \"template_id\": \"<string>\"\n },\n \"schema_version\": 1\n },\n \"description\": \"<string>\",\n \"category\": \"http_api\",\n \"icon\": \"globe\",\n \"icon_color\": \"#3B82F6\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"definition\": {\n \"type\": \"http_api\",\n \"config\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {},\n \"credential_uuid\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"timeout_ms\": 5000,\n \"trigger_phrases\": [\n \"<string>\"\n ],\n \"wait_message\": \"<string>\",\n \"response_fields\": [\n \"<string>\"\n ],\n \"error_message\": \"<string>\",\n \"template_id\": \"<string>\"\n },\n \"schema_version\": 1\n },\n \"description\": \"<string>\",\n \"category\": \"http_api\",\n \"icon\": \"globe\",\n \"icon_color\": \"#3B82F6\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"tool_uuid": "<string>",
"name": "<string>",
"description": "<string>",
"category": "<string>",
"icon": "<string>",
"icon_color": "<string>",
"status": "<string>",
"definition": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": 123,
"provider_id": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Tools
Create Tool
Create a new tool. Returns the created tool.
POST
/
api
/
v1
/
tools
Create Tool
curl --request POST \
--url https://api.example.com/api/v1/tools \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"definition": {
"type": "http_api",
"config": {
"method": "<string>",
"url": "<string>",
"headers": {},
"credential_uuid": "<string>",
"parameters": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>",
"required": true
}
],
"timeout_ms": 5000,
"trigger_phrases": [
"<string>"
],
"wait_message": "<string>",
"response_fields": [
"<string>"
],
"error_message": "<string>",
"template_id": "<string>"
},
"schema_version": 1
},
"description": "<string>",
"category": "http_api",
"icon": "globe",
"icon_color": "#3B82F6"
}
'import requests
url = "https://api.example.com/api/v1/tools"
payload = {
"name": "<string>",
"definition": {
"type": "http_api",
"config": {
"method": "<string>",
"url": "<string>",
"headers": {},
"credential_uuid": "<string>",
"parameters": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>",
"required": True
}
],
"timeout_ms": 5000,
"trigger_phrases": ["<string>"],
"wait_message": "<string>",
"response_fields": ["<string>"],
"error_message": "<string>",
"template_id": "<string>"
},
"schema_version": 1
},
"description": "<string>",
"category": "http_api",
"icon": "globe",
"icon_color": "#3B82F6"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
definition: {
type: 'http_api',
config: {
method: '<string>',
url: '<string>',
headers: {},
credential_uuid: '<string>',
parameters: [{name: '<string>', type: '<string>', description: '<string>', required: true}],
timeout_ms: 5000,
trigger_phrases: ['<string>'],
wait_message: '<string>',
response_fields: ['<string>'],
error_message: '<string>',
template_id: '<string>'
},
schema_version: 1
},
description: '<string>',
category: 'http_api',
icon: 'globe',
icon_color: '#3B82F6'
})
};
fetch('https://api.example.com/api/v1/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/v1/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([
'name' => '<string>',
'definition' => [
'type' => 'http_api',
'config' => [
'method' => '<string>',
'url' => '<string>',
'headers' => [
],
'credential_uuid' => '<string>',
'parameters' => [
[
'name' => '<string>',
'type' => '<string>',
'description' => '<string>',
'required' => true
]
],
'timeout_ms' => 5000,
'trigger_phrases' => [
'<string>'
],
'wait_message' => '<string>',
'response_fields' => [
'<string>'
],
'error_message' => '<string>',
'template_id' => '<string>'
],
'schema_version' => 1
],
'description' => '<string>',
'category' => 'http_api',
'icon' => 'globe',
'icon_color' => '#3B82F6'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.example.com/api/v1/tools"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"definition\": {\n \"type\": \"http_api\",\n \"config\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {},\n \"credential_uuid\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"timeout_ms\": 5000,\n \"trigger_phrases\": [\n \"<string>\"\n ],\n \"wait_message\": \"<string>\",\n \"response_fields\": [\n \"<string>\"\n ],\n \"error_message\": \"<string>\",\n \"template_id\": \"<string>\"\n },\n \"schema_version\": 1\n },\n \"description\": \"<string>\",\n \"category\": \"http_api\",\n \"icon\": \"globe\",\n \"icon_color\": \"#3B82F6\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.example.com/api/v1/tools")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"definition\": {\n \"type\": \"http_api\",\n \"config\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {},\n \"credential_uuid\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"timeout_ms\": 5000,\n \"trigger_phrases\": [\n \"<string>\"\n ],\n \"wait_message\": \"<string>\",\n \"response_fields\": [\n \"<string>\"\n ],\n \"error_message\": \"<string>\",\n \"template_id\": \"<string>\"\n },\n \"schema_version\": 1\n },\n \"description\": \"<string>\",\n \"category\": \"http_api\",\n \"icon\": \"globe\",\n \"icon_color\": \"#3B82F6\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"definition\": {\n \"type\": \"http_api\",\n \"config\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {},\n \"credential_uuid\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"timeout_ms\": 5000,\n \"trigger_phrases\": [\n \"<string>\"\n ],\n \"wait_message\": \"<string>\",\n \"response_fields\": [\n \"<string>\"\n ],\n \"error_message\": \"<string>\",\n \"template_id\": \"<string>\"\n },\n \"schema_version\": 1\n },\n \"description\": \"<string>\",\n \"category\": \"http_api\",\n \"icon\": \"globe\",\n \"icon_color\": \"#3B82F6\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"tool_uuid": "<string>",
"name": "<string>",
"description": "<string>",
"category": "<string>",
"icon": "<string>",
"icon_color": "<string>",
"status": "<string>",
"definition": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": 123,
"provider_id": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).
Body
application/json
Request schema for creating a tool.
Maximum string length:
255Tool definition for HTTP API tools.
- HttpApiToolDefinition
- EndCallToolDefinition
- TransferToolDefinition
- IntegrationToolDefinition
Show child attributes
Show child attributes
Maximum string length:
50Maximum string length:
7Response
Successful Response
Response schema for a tool.
Response schema for the user who created a tool.
Show child attributes
Show child attributes