Get a Configuration
curl --request POST \
--url https://api.heify.com/get-configuration \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
'import requests
url = "https://api.heify.com/get-configuration"
payload = { "configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef" }
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_id: 'a1b2c3d4-e5f6-7890-1234-567890abcdef'})
};
fetch('https://api.heify.com/get-configuration', 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.heify.com/get-configuration",
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_id' => 'a1b2c3d4-e5f6-7890-1234-567890abcdef'
]),
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.heify.com/get-configuration"
payload := strings.NewReader("{\n \"configuration_id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\"\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.heify.com/get-configuration")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"configuration_id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heify.com/get-configuration")
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_id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"configuration": {
"client_id": "client-12345",
"configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"tag": "Customer Support - Technical Issues",
"vocabulary": [
"firewall",
"VPN"
],
"extraction_fields": [
{
"name": "ticket_id",
"type": "string",
"description": "The support ticket number mentioned."
}
],
"webhooks": {
"success_url": "https://myservice.com/webhooks/success",
"error_url": "https://myservice.com/webhooks/error"
},
"summary": true,
"custom_summary": "Focus on the technical issue and resolution.",
"summary_language": "en",
"analytics_language": "en",
"created_at": "2025-01-15T10:00:00.000000+00:00"
}
}
}Configurations
Get Configuration
Retrieve a single configuration by its ID.
POST
/
get-configuration
Get a Configuration
curl --request POST \
--url https://api.heify.com/get-configuration \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
'import requests
url = "https://api.heify.com/get-configuration"
payload = { "configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef" }
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_id: 'a1b2c3d4-e5f6-7890-1234-567890abcdef'})
};
fetch('https://api.heify.com/get-configuration', 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.heify.com/get-configuration",
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_id' => 'a1b2c3d4-e5f6-7890-1234-567890abcdef'
]),
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.heify.com/get-configuration"
payload := strings.NewReader("{\n \"configuration_id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\"\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.heify.com/get-configuration")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"configuration_id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heify.com/get-configuration")
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_id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"configuration": {
"client_id": "client-12345",
"configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"tag": "Customer Support - Technical Issues",
"vocabulary": [
"firewall",
"VPN"
],
"extraction_fields": [
{
"name": "ticket_id",
"type": "string",
"description": "The support ticket number mentioned."
}
],
"webhooks": {
"success_url": "https://myservice.com/webhooks/success",
"error_url": "https://myservice.com/webhooks/error"
},
"summary": true,
"custom_summary": "Focus on the technical issue and resolution.",
"summary_language": "en",
"analytics_language": "en",
"created_at": "2025-01-15T10:00:00.000000+00:00"
}
}
}For full details on all Configuration fields, see Configuration.
Returns
404 if the configuration is not found.⌘I