HTTP Tools
Create HTTP tool
POST
/
public
/
api
/
v1
/
http-tools
Create HTTP tool
curl --request POST \
--url https://api.gennia.ai/public/api/v1/http-tools \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data @- <<EOF
{
"configuration": {},
"description": "Fetches a user's profile information from the CRM by user ID.",
"name": "fetch-user-profile",
"requiresApproval": false
}
EOFimport requests
url = "https://api.gennia.ai/public/api/v1/http-tools"
payload = {
"configuration": {},
"description": "Fetches a user's profile information from the CRM by user ID.",
"name": "fetch-user-profile",
"requiresApproval": False
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
configuration: {},
description: 'Fetches a user\'s profile information from the CRM by user ID.',
name: 'fetch-user-profile',
requiresApproval: false
})
};
fetch('https://api.gennia.ai/public/api/v1/http-tools', 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.gennia.ai/public/api/v1/http-tools",
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([
'configuration' => [
],
'description' => 'Fetches a user\'s profile information from the CRM by user ID.',
'name' => 'fetch-user-profile',
'requiresApproval' => false
]),
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://api.gennia.ai/public/api/v1/http-tools"
payload := strings.NewReader("{\n \"configuration\": {},\n \"description\": \"Fetches a user's profile information from the CRM by user ID.\",\n \"name\": \"fetch-user-profile\",\n \"requiresApproval\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.gennia.ai/public/api/v1/http-tools")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"configuration\": {},\n \"description\": \"Fetches a user's profile information from the CRM by user ID.\",\n \"name\": \"fetch-user-profile\",\n \"requiresApproval\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/http-tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"configuration\": {},\n \"description\": \"Fetches a user's profile information from the CRM by user ID.\",\n \"name\": \"fetch-user-profile\",\n \"requiresApproval\": false\n}"
response = http.request(request)
puts response.read_body{
"configuration": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"configuration": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"configuration": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"configuration": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"configuration": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"updatedAt": "2023-11-07T05:31:56Z"
}Autorizações
Corpo
application/json
Body for creating a new HTTP tool in the workspace.
Type of HTTP tool to create.
Opções disponíveis:
HTTP_REQUEST, DATABASE_QUERY, INTERNAL_VARIABLE, CUSTOM_INTEGRATION, PIPEDREAM_MCP Tool-type-specific configuration object. Shape depends on toolType (URL, headers, body template, etc.).
Show child attributes
Show child attributes
Human-readable description of what the tool does.
Maximum string length:
1000Exemplo:
"Fetches a user's profile information from the CRM by user ID."
Stable identifier of the tool. Must contain only letters, digits, underscores and hyphens.
Maximum string length:
150Pattern:
^[a-zA-Z0-9_-]+$Exemplo:
"fetch-user-profile"
Whether invocations of this tool require human approval before execution.
Exemplo:
false
Resposta
Created
HTTP/DB/Custom tool owned by the workspace.
Tool-type-specific configuration; opaque to the public API.
Show child attributes
Show child attributes
Creator. {publicId: null, name: "API Key"} for API-key-created tools.
Show child attributes
Show child attributes
Opções disponíveis:
HTTP_REQUEST, DATABASE_QUERY, INTERNAL_VARIABLE, CUSTOM_INTEGRATION Esta página foi útil?
⌘I
Create HTTP tool
curl --request POST \
--url https://api.gennia.ai/public/api/v1/http-tools \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data @- <<EOF
{
"configuration": {},
"description": "Fetches a user's profile information from the CRM by user ID.",
"name": "fetch-user-profile",
"requiresApproval": false
}
EOFimport requests
url = "https://api.gennia.ai/public/api/v1/http-tools"
payload = {
"configuration": {},
"description": "Fetches a user's profile information from the CRM by user ID.",
"name": "fetch-user-profile",
"requiresApproval": False
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
configuration: {},
description: 'Fetches a user\'s profile information from the CRM by user ID.',
name: 'fetch-user-profile',
requiresApproval: false
})
};
fetch('https://api.gennia.ai/public/api/v1/http-tools', 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.gennia.ai/public/api/v1/http-tools",
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([
'configuration' => [
],
'description' => 'Fetches a user\'s profile information from the CRM by user ID.',
'name' => 'fetch-user-profile',
'requiresApproval' => false
]),
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://api.gennia.ai/public/api/v1/http-tools"
payload := strings.NewReader("{\n \"configuration\": {},\n \"description\": \"Fetches a user's profile information from the CRM by user ID.\",\n \"name\": \"fetch-user-profile\",\n \"requiresApproval\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.gennia.ai/public/api/v1/http-tools")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"configuration\": {},\n \"description\": \"Fetches a user's profile information from the CRM by user ID.\",\n \"name\": \"fetch-user-profile\",\n \"requiresApproval\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/http-tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"configuration\": {},\n \"description\": \"Fetches a user's profile information from the CRM by user ID.\",\n \"name\": \"fetch-user-profile\",\n \"requiresApproval\": false\n}"
response = http.request(request)
puts response.read_body{
"configuration": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"configuration": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"configuration": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"configuration": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"configuration": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"updatedAt": "2023-11-07T05:31:56Z"
}
