Create new tool
curl --request POST \
--url https://prod.featherhq.com/api/v1/tools \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"structure": {
"url": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": false
}
],
"method": "GET",
"headers": [],
"body": {},
"timeout": 30
},
"slug": "<string>",
"speech": "<string>",
"notifyOnFailure": false,
"successStatusCodes": [
200
]
}
'import requests
url = "https://prod.featherhq.com/api/v1/tools"
payload = {
"name": "<string>",
"description": "<string>",
"structure": {
"url": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": False
}
],
"method": "GET",
"headers": [],
"body": {},
"timeout": 30
},
"slug": "<string>",
"speech": "<string>",
"notifyOnFailure": False,
"successStatusCodes": [200]
}
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({
name: '<string>',
description: '<string>',
structure: {
url: '<string>',
variables: [{name: '<string>', description: '<string>', required: false}],
method: 'GET',
headers: [],
body: JSON.stringify({}),
timeout: 30
},
slug: '<string>',
speech: '<string>',
notifyOnFailure: false,
successStatusCodes: [200]
})
};
fetch('https://prod.featherhq.com/api/v1/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://prod.featherhq.com/api/v1/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([
'name' => '<string>',
'description' => '<string>',
'structure' => [
'url' => '<string>',
'variables' => [
[
'name' => '<string>',
'description' => '<string>',
'required' => false
]
],
'method' => 'GET',
'headers' => [
],
'body' => [
],
'timeout' => 30
],
'slug' => '<string>',
'speech' => '<string>',
'notifyOnFailure' => false,
'successStatusCodes' => [
200
]
]),
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://prod.featherhq.com/api/v1/tools"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"structure\": {\n \"url\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false\n }\n ],\n \"method\": \"GET\",\n \"headers\": [],\n \"body\": {},\n \"timeout\": 30\n },\n \"slug\": \"<string>\",\n \"speech\": \"<string>\",\n \"notifyOnFailure\": false,\n \"successStatusCodes\": [\n 200\n ]\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://prod.featherhq.com/api/v1/tools")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"structure\": {\n \"url\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false\n }\n ],\n \"method\": \"GET\",\n \"headers\": [],\n \"body\": {},\n \"timeout\": 30\n },\n \"slug\": \"<string>\",\n \"speech\": \"<string>\",\n \"notifyOnFailure\": false,\n \"successStatusCodes\": [\n 200\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.featherhq.com/api/v1/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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"structure\": {\n \"url\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false\n }\n ],\n \"method\": \"GET\",\n \"headers\": [],\n \"body\": {},\n \"timeout\": 30\n },\n \"slug\": \"<string>\",\n \"speech\": \"<string>\",\n \"notifyOnFailure\": false,\n \"successStatusCodes\": [\n 200\n ]\n}"
response = http.request(request)
puts response.read_body{
"tool": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"notifyOnFailure": true,
"successStatusCodes": [
349
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"structure": {
"url": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": false
}
],
"method": "GET",
"headers": [],
"body": {},
"timeout": 30
},
"speech": "<string>",
"slug": "<string>"
}
}{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}{
"status": 500,
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"success": false
}Tools
Create new tool
Create a new tool
POST
/
api
/
v1
/
tools
Create new tool
curl --request POST \
--url https://prod.featherhq.com/api/v1/tools \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"structure": {
"url": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": false
}
],
"method": "GET",
"headers": [],
"body": {},
"timeout": 30
},
"slug": "<string>",
"speech": "<string>",
"notifyOnFailure": false,
"successStatusCodes": [
200
]
}
'import requests
url = "https://prod.featherhq.com/api/v1/tools"
payload = {
"name": "<string>",
"description": "<string>",
"structure": {
"url": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": False
}
],
"method": "GET",
"headers": [],
"body": {},
"timeout": 30
},
"slug": "<string>",
"speech": "<string>",
"notifyOnFailure": False,
"successStatusCodes": [200]
}
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({
name: '<string>',
description: '<string>',
structure: {
url: '<string>',
variables: [{name: '<string>', description: '<string>', required: false}],
method: 'GET',
headers: [],
body: JSON.stringify({}),
timeout: 30
},
slug: '<string>',
speech: '<string>',
notifyOnFailure: false,
successStatusCodes: [200]
})
};
fetch('https://prod.featherhq.com/api/v1/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://prod.featherhq.com/api/v1/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([
'name' => '<string>',
'description' => '<string>',
'structure' => [
'url' => '<string>',
'variables' => [
[
'name' => '<string>',
'description' => '<string>',
'required' => false
]
],
'method' => 'GET',
'headers' => [
],
'body' => [
],
'timeout' => 30
],
'slug' => '<string>',
'speech' => '<string>',
'notifyOnFailure' => false,
'successStatusCodes' => [
200
]
]),
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://prod.featherhq.com/api/v1/tools"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"structure\": {\n \"url\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false\n }\n ],\n \"method\": \"GET\",\n \"headers\": [],\n \"body\": {},\n \"timeout\": 30\n },\n \"slug\": \"<string>\",\n \"speech\": \"<string>\",\n \"notifyOnFailure\": false,\n \"successStatusCodes\": [\n 200\n ]\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://prod.featherhq.com/api/v1/tools")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"structure\": {\n \"url\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false\n }\n ],\n \"method\": \"GET\",\n \"headers\": [],\n \"body\": {},\n \"timeout\": 30\n },\n \"slug\": \"<string>\",\n \"speech\": \"<string>\",\n \"notifyOnFailure\": false,\n \"successStatusCodes\": [\n 200\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.featherhq.com/api/v1/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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"structure\": {\n \"url\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false\n }\n ],\n \"method\": \"GET\",\n \"headers\": [],\n \"body\": {},\n \"timeout\": 30\n },\n \"slug\": \"<string>\",\n \"speech\": \"<string>\",\n \"notifyOnFailure\": false,\n \"successStatusCodes\": [\n 200\n ]\n}"
response = http.request(request)
puts response.read_body{
"tool": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"notifyOnFailure": true,
"successStatusCodes": [
349
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"structure": {
"url": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": false
}
],
"method": "GET",
"headers": [],
"body": {},
"timeout": 30
},
"speech": "<string>",
"slug": "<string>"
}
}{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}{
"status": 500,
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"success": false
}Authorizations
Body
application/json
Response
New tool created successfully
Show child attributes
Show child attributes
⌘I