Update an existing tool
curl --request PATCH \
--url https://flowra.dev/api/v1/tools/byId/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"deprecatedInfo": {
"displayName": "<string>",
"version": "<string>",
"availableVersions": [
"<string>"
],
"isDeprecated": true,
"toolkit": {
"logo": "<string>"
}
},
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"toolkitSlug": "<string>",
"inputParameters": {},
"outputParameters": {},
"noAuth": false,
"scopes": [
"<string>"
],
"tags": [
"<string>"
],
"isImportant": false,
"popularityScore": 0,
"type": "action",
"availableVersions": [
"<string>"
],
"version": "1.0.0",
"isDeprecated": false,
"isDisabled": false,
"triggerThreadKey": "<string>",
"script": "<unknown>",
"executionCreditCost": 1
}
'import requests
url = "https://flowra.dev/api/v1/tools/byId/{id}"
payload = {
"deprecatedInfo": {
"displayName": "<string>",
"version": "<string>",
"availableVersions": ["<string>"],
"isDeprecated": True,
"toolkit": { "logo": "<string>" }
},
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"toolkitSlug": "<string>",
"inputParameters": {},
"outputParameters": {},
"noAuth": False,
"scopes": ["<string>"],
"tags": ["<string>"],
"isImportant": False,
"popularityScore": 0,
"type": "action",
"availableVersions": ["<string>"],
"version": "1.0.0",
"isDeprecated": False,
"isDisabled": False,
"triggerThreadKey": "<string>",
"script": "<unknown>",
"executionCreditCost": 1
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deprecatedInfo: {
displayName: '<string>',
version: '<string>',
availableVersions: ['<string>'],
isDeprecated: true,
toolkit: {logo: '<string>'}
},
slug: '<string>',
name: '<string>',
description: '<string>',
instructions: '<string>',
toolkitSlug: '<string>',
inputParameters: {},
outputParameters: {},
noAuth: false,
scopes: ['<string>'],
tags: ['<string>'],
isImportant: false,
popularityScore: 0,
type: 'action',
availableVersions: ['<string>'],
version: '1.0.0',
isDeprecated: false,
isDisabled: false,
triggerThreadKey: '<string>',
script: '<unknown>',
executionCreditCost: 1
})
};
fetch('https://flowra.dev/api/v1/tools/byId/{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://flowra.dev/api/v1/tools/byId/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'deprecatedInfo' => [
'displayName' => '<string>',
'version' => '<string>',
'availableVersions' => [
'<string>'
],
'isDeprecated' => true,
'toolkit' => [
'logo' => '<string>'
]
],
'slug' => '<string>',
'name' => '<string>',
'description' => '<string>',
'instructions' => '<string>',
'toolkitSlug' => '<string>',
'inputParameters' => [
],
'outputParameters' => [
],
'noAuth' => false,
'scopes' => [
'<string>'
],
'tags' => [
'<string>'
],
'isImportant' => false,
'popularityScore' => 0,
'type' => 'action',
'availableVersions' => [
'<string>'
],
'version' => '1.0.0',
'isDeprecated' => false,
'isDisabled' => false,
'triggerThreadKey' => '<string>',
'script' => '<unknown>',
'executionCreditCost' => 1
]),
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://flowra.dev/api/v1/tools/byId/{id}"
payload := strings.NewReader("{\n \"deprecatedInfo\": {\n \"displayName\": \"<string>\",\n \"version\": \"<string>\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"isDeprecated\": true,\n \"toolkit\": {\n \"logo\": \"<string>\"\n }\n },\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"toolkitSlug\": \"<string>\",\n \"inputParameters\": {},\n \"outputParameters\": {},\n \"noAuth\": false,\n \"scopes\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"isImportant\": false,\n \"popularityScore\": 0,\n \"type\": \"action\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\",\n \"isDeprecated\": false,\n \"isDisabled\": false,\n \"triggerThreadKey\": \"<string>\",\n \"script\": \"<unknown>\",\n \"executionCreditCost\": 1\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://flowra.dev/api/v1/tools/byId/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"deprecatedInfo\": {\n \"displayName\": \"<string>\",\n \"version\": \"<string>\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"isDeprecated\": true,\n \"toolkit\": {\n \"logo\": \"<string>\"\n }\n },\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"toolkitSlug\": \"<string>\",\n \"inputParameters\": {},\n \"outputParameters\": {},\n \"noAuth\": false,\n \"scopes\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"isImportant\": false,\n \"popularityScore\": 0,\n \"type\": \"action\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\",\n \"isDeprecated\": false,\n \"isDisabled\": false,\n \"triggerThreadKey\": \"<string>\",\n \"script\": \"<unknown>\",\n \"executionCreditCost\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/tools/byId/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deprecatedInfo\": {\n \"displayName\": \"<string>\",\n \"version\": \"<string>\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"isDeprecated\": true,\n \"toolkit\": {\n \"logo\": \"<string>\"\n }\n },\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"toolkitSlug\": \"<string>\",\n \"inputParameters\": {},\n \"outputParameters\": {},\n \"noAuth\": false,\n \"scopes\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"isImportant\": false,\n \"popularityScore\": 0,\n \"type\": \"action\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\",\n \"isDeprecated\": false,\n \"isDisabled\": false,\n \"triggerThreadKey\": \"<string>\",\n \"script\": \"<unknown>\",\n \"executionCreditCost\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {}
}Tools
Update an existing tool
Update a tool’s name, description, input schema, or configuration. Only the fields you send are changed.
PATCH
/
api
/
v1
/
tools
/
byId
/
{id}
Update an existing tool
curl --request PATCH \
--url https://flowra.dev/api/v1/tools/byId/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"deprecatedInfo": {
"displayName": "<string>",
"version": "<string>",
"availableVersions": [
"<string>"
],
"isDeprecated": true,
"toolkit": {
"logo": "<string>"
}
},
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"toolkitSlug": "<string>",
"inputParameters": {},
"outputParameters": {},
"noAuth": false,
"scopes": [
"<string>"
],
"tags": [
"<string>"
],
"isImportant": false,
"popularityScore": 0,
"type": "action",
"availableVersions": [
"<string>"
],
"version": "1.0.0",
"isDeprecated": false,
"isDisabled": false,
"triggerThreadKey": "<string>",
"script": "<unknown>",
"executionCreditCost": 1
}
'import requests
url = "https://flowra.dev/api/v1/tools/byId/{id}"
payload = {
"deprecatedInfo": {
"displayName": "<string>",
"version": "<string>",
"availableVersions": ["<string>"],
"isDeprecated": True,
"toolkit": { "logo": "<string>" }
},
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"toolkitSlug": "<string>",
"inputParameters": {},
"outputParameters": {},
"noAuth": False,
"scopes": ["<string>"],
"tags": ["<string>"],
"isImportant": False,
"popularityScore": 0,
"type": "action",
"availableVersions": ["<string>"],
"version": "1.0.0",
"isDeprecated": False,
"isDisabled": False,
"triggerThreadKey": "<string>",
"script": "<unknown>",
"executionCreditCost": 1
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deprecatedInfo: {
displayName: '<string>',
version: '<string>',
availableVersions: ['<string>'],
isDeprecated: true,
toolkit: {logo: '<string>'}
},
slug: '<string>',
name: '<string>',
description: '<string>',
instructions: '<string>',
toolkitSlug: '<string>',
inputParameters: {},
outputParameters: {},
noAuth: false,
scopes: ['<string>'],
tags: ['<string>'],
isImportant: false,
popularityScore: 0,
type: 'action',
availableVersions: ['<string>'],
version: '1.0.0',
isDeprecated: false,
isDisabled: false,
triggerThreadKey: '<string>',
script: '<unknown>',
executionCreditCost: 1
})
};
fetch('https://flowra.dev/api/v1/tools/byId/{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://flowra.dev/api/v1/tools/byId/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'deprecatedInfo' => [
'displayName' => '<string>',
'version' => '<string>',
'availableVersions' => [
'<string>'
],
'isDeprecated' => true,
'toolkit' => [
'logo' => '<string>'
]
],
'slug' => '<string>',
'name' => '<string>',
'description' => '<string>',
'instructions' => '<string>',
'toolkitSlug' => '<string>',
'inputParameters' => [
],
'outputParameters' => [
],
'noAuth' => false,
'scopes' => [
'<string>'
],
'tags' => [
'<string>'
],
'isImportant' => false,
'popularityScore' => 0,
'type' => 'action',
'availableVersions' => [
'<string>'
],
'version' => '1.0.0',
'isDeprecated' => false,
'isDisabled' => false,
'triggerThreadKey' => '<string>',
'script' => '<unknown>',
'executionCreditCost' => 1
]),
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://flowra.dev/api/v1/tools/byId/{id}"
payload := strings.NewReader("{\n \"deprecatedInfo\": {\n \"displayName\": \"<string>\",\n \"version\": \"<string>\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"isDeprecated\": true,\n \"toolkit\": {\n \"logo\": \"<string>\"\n }\n },\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"toolkitSlug\": \"<string>\",\n \"inputParameters\": {},\n \"outputParameters\": {},\n \"noAuth\": false,\n \"scopes\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"isImportant\": false,\n \"popularityScore\": 0,\n \"type\": \"action\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\",\n \"isDeprecated\": false,\n \"isDisabled\": false,\n \"triggerThreadKey\": \"<string>\",\n \"script\": \"<unknown>\",\n \"executionCreditCost\": 1\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://flowra.dev/api/v1/tools/byId/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"deprecatedInfo\": {\n \"displayName\": \"<string>\",\n \"version\": \"<string>\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"isDeprecated\": true,\n \"toolkit\": {\n \"logo\": \"<string>\"\n }\n },\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"toolkitSlug\": \"<string>\",\n \"inputParameters\": {},\n \"outputParameters\": {},\n \"noAuth\": false,\n \"scopes\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"isImportant\": false,\n \"popularityScore\": 0,\n \"type\": \"action\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\",\n \"isDeprecated\": false,\n \"isDisabled\": false,\n \"triggerThreadKey\": \"<string>\",\n \"script\": \"<unknown>\",\n \"executionCreditCost\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/tools/byId/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deprecatedInfo\": {\n \"displayName\": \"<string>\",\n \"version\": \"<string>\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"isDeprecated\": true,\n \"toolkit\": {\n \"logo\": \"<string>\"\n }\n },\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"toolkitSlug\": \"<string>\",\n \"inputParameters\": {},\n \"outputParameters\": {},\n \"noAuth\": false,\n \"scopes\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"isImportant\": false,\n \"popularityScore\": 0,\n \"type\": \"action\",\n \"availableVersions\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\",\n \"isDeprecated\": false,\n \"isDisabled\": false,\n \"triggerThreadKey\": \"<string>\",\n \"script\": \"<unknown>\",\n \"executionCreditCost\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {}
}Authorizations
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
Tool updated successfully
Show child attributes
Show child attributes
Was this page helpful?
⌘I