Get tool by ID
curl --request GET \
--url https://flowra.dev/api/v1/tools/byId/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://flowra.dev/api/v1/tools/byId/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/tools/byId/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://flowra.dev/api/v1/tools/byId/{id}")
.header("x-api-key", "<api-key>")
.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::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"slug": "gmail_send_email",
"name": "Send Email",
"description": "Sends an email via Gmail",
"instructions": "Use when the user asks to send an email.",
"toolkitSlug": "gmail",
"inputParameters": {
"type": "object",
"properties": {
"to": {
"type": "string"
}
}
},
"outputParameters": {
"type": "object",
"properties": {
"messageId": {
"type": "string"
}
}
},
"noAuth": false,
"availableVersions": [
"1.0.0"
],
"version": "1.0.0",
"scopes": [
"gmail.send"
],
"tags": [
"email"
],
"isImportant": false,
"isDeprecated": false,
"isDisabled": false,
"popularityScore": 12,
"provider": "COMPOSIO",
"type": "action",
"ragContentHash": "",
"ragSyncedAt": "2024-01-01T00:00:00.000Z",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"fieldModifiers": {},
"script": "javascript",
"executionCreditCost": 0
}
}Tools
Get tool by ID
Get full details of a tool: name, description, input schema, script, and configuration. Use the tool slug or ID when executing or editing the tool.
GET
/
api
/
v1
/
tools
/
byId
/
{id}
Get tool by ID
curl --request GET \
--url https://flowra.dev/api/v1/tools/byId/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://flowra.dev/api/v1/tools/byId/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/tools/byId/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://flowra.dev/api/v1/tools/byId/{id}")
.header("x-api-key", "<api-key>")
.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::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"slug": "gmail_send_email",
"name": "Send Email",
"description": "Sends an email via Gmail",
"instructions": "Use when the user asks to send an email.",
"toolkitSlug": "gmail",
"inputParameters": {
"type": "object",
"properties": {
"to": {
"type": "string"
}
}
},
"outputParameters": {
"type": "object",
"properties": {
"messageId": {
"type": "string"
}
}
},
"noAuth": false,
"availableVersions": [
"1.0.0"
],
"version": "1.0.0",
"scopes": [
"gmail.send"
],
"tags": [
"email"
],
"isImportant": false,
"isDeprecated": false,
"isDisabled": false,
"popularityScore": 12,
"provider": "COMPOSIO",
"type": "action",
"ragContentHash": "",
"ragSyncedAt": "2024-01-01T00:00:00.000Z",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"fieldModifiers": {},
"script": "javascript",
"executionCreditCost": 0
}
}Authorizations
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Path Parameters
Tool ID (UUID) or slug, depending on lookup
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Query Parameters
Optional version of the tool to retrieve
Example:
"2.0.0"
Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit.
Example:
"latest"
Response
200 - application/json
Tool details retrieved successfully
Success status
Example:
true
Success message
Example:
"Operation completed successfully"
Show child attributes
Show child attributes
Example:
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"slug": "gmail_send_email",
"name": "Send Email",
"description": "Sends an email via Gmail",
"instructions": "Use when the user asks to send an email.",
"toolkitSlug": "gmail",
"inputParameters": {
"type": "object",
"properties": { "to": { "type": "string" } }
},
"outputParameters": {
"type": "object",
"properties": { "messageId": { "type": "string" } }
},
"noAuth": false,
"availableVersions": ["1.0.0"],
"version": "1.0.0",
"scopes": ["gmail.send"],
"tags": ["email"],
"isImportant": false,
"isDeprecated": false,
"isDisabled": false,
"popularityScore": 12,
"provider": "COMPOSIO",
"type": "action",
"ragContentHash": "",
"ragSyncedAt": "2024-01-01T00:00:00.000Z",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"fieldModifiers": {},
"script": "javascript",
"executionCreditCost": 0
}
Was this page helpful?