Create Custom Tool
curl --request POST \
--url https://cloud.onyx.app/api/admin/tool/custom \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"definition": {},
"passthrough_auth": true,
"description": "<string>",
"custom_headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"oauth_config_id": 123
}
'import requests
url = "https://cloud.onyx.app/api/admin/tool/custom"
payload = {
"name": "<string>",
"definition": {},
"passthrough_auth": True,
"description": "<string>",
"custom_headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"oauth_config_id": 123
}
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({
name: '<string>',
definition: {},
passthrough_auth: true,
description: '<string>',
custom_headers: [{key: '<string>', value: '<string>'}],
oauth_config_id: 123
})
};
fetch('https://cloud.onyx.app/api/admin/tool/custom', 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://cloud.onyx.app/api/admin/tool/custom",
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' => [
],
'passthrough_auth' => true,
'description' => '<string>',
'custom_headers' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'oauth_config_id' => 123
]),
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://cloud.onyx.app/api/admin/tool/custom"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"definition\": {},\n \"passthrough_auth\": true,\n \"description\": \"<string>\",\n \"custom_headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"oauth_config_id\": 123\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://cloud.onyx.app/api/admin/tool/custom")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"definition\": {},\n \"passthrough_auth\": true,\n \"description\": \"<string>\",\n \"custom_headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"oauth_config_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/admin/tool/custom")
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 \"name\": \"<string>\",\n \"definition\": {},\n \"passthrough_auth\": true,\n \"description\": \"<string>\",\n \"custom_headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"oauth_config_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<unknown>"
],
"passthrough_auth": true,
"mcp_server_id": 123,
"user_id": "<string>",
"oauth_config_id": 123,
"oauth_config_name": "<string>",
"enabled": true,
"chat_selectable": true,
"agent_creation_selectable": true,
"default_enabled": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Actions
Create Custom Tool
POST
/
admin
/
tool
/
custom
Create Custom Tool
curl --request POST \
--url https://cloud.onyx.app/api/admin/tool/custom \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"definition": {},
"passthrough_auth": true,
"description": "<string>",
"custom_headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"oauth_config_id": 123
}
'import requests
url = "https://cloud.onyx.app/api/admin/tool/custom"
payload = {
"name": "<string>",
"definition": {},
"passthrough_auth": True,
"description": "<string>",
"custom_headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"oauth_config_id": 123
}
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({
name: '<string>',
definition: {},
passthrough_auth: true,
description: '<string>',
custom_headers: [{key: '<string>', value: '<string>'}],
oauth_config_id: 123
})
};
fetch('https://cloud.onyx.app/api/admin/tool/custom', 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://cloud.onyx.app/api/admin/tool/custom",
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' => [
],
'passthrough_auth' => true,
'description' => '<string>',
'custom_headers' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'oauth_config_id' => 123
]),
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://cloud.onyx.app/api/admin/tool/custom"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"definition\": {},\n \"passthrough_auth\": true,\n \"description\": \"<string>\",\n \"custom_headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"oauth_config_id\": 123\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://cloud.onyx.app/api/admin/tool/custom")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"definition\": {},\n \"passthrough_auth\": true,\n \"description\": \"<string>\",\n \"custom_headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"oauth_config_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/admin/tool/custom")
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 \"name\": \"<string>\",\n \"definition\": {},\n \"passthrough_auth\": true,\n \"description\": \"<string>\",\n \"custom_headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"oauth_config_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<unknown>"
],
"passthrough_auth": true,
"mcp_server_id": 123,
"user_id": "<string>",
"oauth_config_id": 123,
"oauth_config_name": "<string>",
"enabled": true,
"chat_selectable": true,
"agent_creation_selectable": true,
"default_enabled": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Authorization header with Bearer token
Body
application/json
Response
Successful Response
Was this page helpful?
⌘I