Update Custom Tool

curl --request PUT \
  --url https://cloud.onyx.app/api/admin/tool/custom/{tool_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "definition": {},
  "custom_headers": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "passthrough_auth": true,
  "oauth_config_id": 123
}
'

import requests

url = "https://cloud.onyx.app/api/admin/tool/custom/{tool_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "definition": {},
    "custom_headers": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "passthrough_auth": True,
    "oauth_config_id": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    definition: {},
    custom_headers: [{key: '<string>', value: '<string>'}],
    passthrough_auth: true,
    oauth_config_id: 123
  })
};

fetch('https://cloud.onyx.app/api/admin/tool/custom/{tool_id}', 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/{tool_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'definition' => [
        
    ],
    'custom_headers' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'passthrough_auth' => true,
    '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/{tool_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"definition\": {},\n  \"custom_headers\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"passthrough_auth\": true,\n  \"oauth_config_id\": 123\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://cloud.onyx.app/api/admin/tool/custom/{tool_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"definition\": {},\n  \"custom_headers\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"passthrough_auth\": true,\n  \"oauth_config_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.onyx.app/api/admin/tool/custom/{tool_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"definition\": {},\n  \"custom_headers\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"passthrough_auth\": true,\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>"
    }
  ]
}

PUT

admin

tool

custom

{tool_id}

Update Custom Tool

curl --request PUT \
  --url https://cloud.onyx.app/api/admin/tool/custom/{tool_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "definition": {},
  "custom_headers": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "passthrough_auth": true,
  "oauth_config_id": 123
}
'

import requests

url = "https://cloud.onyx.app/api/admin/tool/custom/{tool_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "definition": {},
    "custom_headers": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "passthrough_auth": True,
    "oauth_config_id": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    definition: {},
    custom_headers: [{key: '<string>', value: '<string>'}],
    passthrough_auth: true,
    oauth_config_id: 123
  })
};

fetch('https://cloud.onyx.app/api/admin/tool/custom/{tool_id}', 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/{tool_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'definition' => [
        
    ],
    'custom_headers' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'passthrough_auth' => true,
    '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/{tool_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"definition\": {},\n  \"custom_headers\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"passthrough_auth\": true,\n  \"oauth_config_id\": 123\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://cloud.onyx.app/api/admin/tool/custom/{tool_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"definition\": {},\n  \"custom_headers\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"passthrough_auth\": true,\n  \"oauth_config_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.onyx.app/api/admin/tool/custom/{tool_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"definition\": {},\n  \"custom_headers\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"passthrough_auth\": true,\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>"
    }
  ]
}

Required permission: Manage Actions (manage:actions), or Admin (admin). A Group Manager can also call this. Their scope comes from the agents shared with the groups they manage.

Authorizations

Authorization

string

header

required

Authorization header with Bearer token

Path Parameters

tool_id

integer

required

Body

application/json

name

string | null

description

string | null

definition

Definition · object | null

custom_headers

Header · object[] | null

Show child attributes

passthrough_auth

boolean | null

oauth_config_id

integer | null

Response

Successful Response

integer

required

name

string

required

description

string

required

definition

Definition · object | null

required

display_name

string

required

in_code_tool_id

string | null

required

custom_headers

any[] | null

required

passthrough_auth

boolean

required

mcp_server_id

integer | null

user_id

string | null

oauth_config_id

integer | null

oauth_config_name

string | null

enabled

boolean

default:true

chat_selectable

boolean

default:true

agent_creation_selectable

boolean

default:true

default_enabled

boolean

default:false

Getting Started

Guides & Examples

API Reference

Miscellaneous

Update Custom Tool

Authorizations

Path Parameters

Body

Response