Get Tool
curl --request GET \
--url https://api.example.com/api/tools/{tool_id} \
--header 'X-API-Key: <x-api-key>' \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://api.example.com/api/tools/{tool_id}"
headers = {
"X-API-Key": "<x-api-key>",
"X-Organization-Id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-Key': '<x-api-key>', 'X-Organization-Id': '<x-organization-id>'}
};
fetch('https://api.example.com/api/tools/{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://api.example.com/api/tools/{tool_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: <x-api-key>",
"X-Organization-Id: <x-organization-id>"
],
]);
$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://api.example.com/api/tools/{tool_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("X-Organization-Id", "<x-organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/tools/{tool_id}")
.header("X-API-Key", "<x-api-key>")
.header("X-Organization-Id", "<x-organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/tools/{tool_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
request["X-Organization-Id"] = '<x-organization-id>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"tool_id": "tool_a1b2c3d4e5f6",
"tool_name": "GetOrderStatus",
"tool_description": "Retrieves the status of a customer order using their order ID",
"webhook_url": "https://api.shop.com/orders/status",
"http_method": "POST",
"headers": {
"Authorization": "Bearer token123"
},
"parameters": [
{
"parameter_name": "order_id",
"parameter_type": "string",
"parameter_description": "The unique order identifier",
"parameter_required": true
}
],
"timeout_seconds": 30,
"client_id": "org_abc123",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:45:00Z"
}
}
Tools
Get Tool
GET
/
api
/
tools
/
{tool_id}
Get Tool
curl --request GET \
--url https://api.example.com/api/tools/{tool_id} \
--header 'X-API-Key: <x-api-key>' \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://api.example.com/api/tools/{tool_id}"
headers = {
"X-API-Key": "<x-api-key>",
"X-Organization-Id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-Key': '<x-api-key>', 'X-Organization-Id': '<x-organization-id>'}
};
fetch('https://api.example.com/api/tools/{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://api.example.com/api/tools/{tool_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: <x-api-key>",
"X-Organization-Id: <x-organization-id>"
],
]);
$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://api.example.com/api/tools/{tool_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("X-Organization-Id", "<x-organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/tools/{tool_id}")
.header("X-API-Key", "<x-api-key>")
.header("X-Organization-Id", "<x-organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/tools/{tool_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
request["X-Organization-Id"] = '<x-organization-id>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"tool_id": "tool_a1b2c3d4e5f6",
"tool_name": "GetOrderStatus",
"tool_description": "Retrieves the status of a customer order using their order ID",
"webhook_url": "https://api.shop.com/orders/status",
"http_method": "POST",
"headers": {
"Authorization": "Bearer token123"
},
"parameters": [
{
"parameter_name": "order_id",
"parameter_type": "string",
"parameter_description": "The unique order identifier",
"parameter_required": true
}
],
"timeout_seconds": 30,
"client_id": "org_abc123",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:45:00Z"
}
}
Get configuration details of a specific tool.
Headers
string
required
Your API key for authentication.
string
required
The organization ID.
Path Parameters
string
required
The unique identifier of the tool (format:
tool_[a-f0-9]{12,}).Permissions
tools:read(all roles)
Response
boolean
Indicates if the request was successful.
object
The full tool configuration object.
Show properties
Show properties
string
Unique tool identifier.
string
Name of the tool.
string
Description of what the tool does.
string
The API endpoint URL.
string
HTTP method: GET, POST, PUT, PATCH, or DELETE.
object
HTTP headers to include in requests.
array
List of parameter definitions.
integer
Timeout in seconds.
string
Organization ID.
string
ISO 8601 timestamp of creation.
string
ISO 8601 timestamp of last update.
{
"success": true,
"data": {
"tool_id": "tool_a1b2c3d4e5f6",
"tool_name": "GetOrderStatus",
"tool_description": "Retrieves the status of a customer order using their order ID",
"webhook_url": "https://api.shop.com/orders/status",
"http_method": "POST",
"headers": {
"Authorization": "Bearer token123"
},
"parameters": [
{
"parameter_name": "order_id",
"parameter_type": "string",
"parameter_description": "The unique order identifier",
"parameter_required": true
}
],
"timeout_seconds": 30,
"client_id": "org_abc123",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:45:00Z"
}
}
Errors
object
Tool not found.
object
Tool belongs to different organization.
⌘I