Generate Agent Tone

POST

agent-builder

generate-agent-tone

Generate Agent Tone

curl --request POST \
  --url https://api.dialnexa.com/v1/agent-builder/generate-agent-tone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_and_offering": "Example company and offering",
  "target_customer": "Example target customer",
  "primary_goal": "Example primary goal",
  "success_criteria": "Example success criteria",
  "information_to_collect": "Example information to collect",
  "objections_and_faqs": "Example objections and faqs"
}
'

import requests

url = "https://api.dialnexa.com/v1/agent-builder/generate-agent-tone"

payload = {
    "company_and_offering": "Example company and offering",
    "target_customer": "Example target customer",
    "primary_goal": "Example primary goal",
    "success_criteria": "Example success criteria",
    "information_to_collect": "Example information to collect",
    "objections_and_faqs": "Example objections and faqs"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_and_offering: 'Example company and offering',
    target_customer: 'Example target customer',
    primary_goal: 'Example primary goal',
    success_criteria: 'Example success criteria',
    information_to_collect: 'Example information to collect',
    objections_and_faqs: 'Example objections and faqs'
  })
};

fetch('https://api.dialnexa.com/v1/agent-builder/generate-agent-tone', 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.dialnexa.com/v1/agent-builder/generate-agent-tone",
  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([
    'company_and_offering' => 'Example company and offering',
    'target_customer' => 'Example target customer',
    'primary_goal' => 'Example primary goal',
    'success_criteria' => 'Example success criteria',
    'information_to_collect' => 'Example information to collect',
    'objections_and_faqs' => 'Example objections and faqs'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.dialnexa.com/v1/agent-builder/generate-agent-tone"

	payload := strings.NewReader("{\n  \"company_and_offering\": \"Example company and offering\",\n  \"target_customer\": \"Example target customer\",\n  \"primary_goal\": \"Example primary goal\",\n  \"success_criteria\": \"Example success criteria\",\n  \"information_to_collect\": \"Example information to collect\",\n  \"objections_and_faqs\": \"Example objections and faqs\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.dialnexa.com/v1/agent-builder/generate-agent-tone")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_and_offering\": \"Example company and offering\",\n  \"target_customer\": \"Example target customer\",\n  \"primary_goal\": \"Example primary goal\",\n  \"success_criteria\": \"Example success criteria\",\n  \"information_to_collect\": \"Example information to collect\",\n  \"objections_and_faqs\": \"Example objections and faqs\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/agent-builder/generate-agent-tone")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_and_offering\": \"Example company and offering\",\n  \"target_customer\": \"Example target customer\",\n  \"primary_goal\": \"Example primary goal\",\n  \"success_criteria\": \"Example success criteria\",\n  \"information_to_collect\": \"Example information to collect\",\n  \"objections_and_faqs\": \"Example objections and faqs\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "error": false,
  "statusCode": 201,
  "message": "Success",
  "data": {
    "agent_tone": "<string>",
    "inferred_region": "<string>",
    "inferred_language": "<string>"
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

Read only Generate Agent Tone uses your workspace API key. Drafts an agent tone and inferred locale from the supplied context without changing an agent.

Before you begin

Use a server-side API key for the intended workspace.

Generate Agent Tone request

The request panel lists supported query parameters and body fields. For a request body, the example below supplies the required fields. Replace sample values with your own inputs.

curl --request POST 'https://api.dialnexa.com/v1/agent-builder/generate-agent-tone' \
  --header "Authorization: Bearer $DIALNEXA_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "company_and_offering": "Example company and offering",
  "target_customer": "Example target customer",
  "primary_goal": "Example primary goal",
  "success_criteria": "Example success criteria",
  "information_to_collect": "Example information to collect",
  "objections_and_faqs": "Example objections and faqs"
}'

Verify the result

Expect HTTP 201. Read the data property in the success envelope; the response panel documents its fields. This operation also accepts the matching /v1/assistant path. The request and result contracts are shared. Use one path consistently for your integration.

Retry safety

This operation does not modify workspace resources. Retry after a transient connection failure.

Errors and recovery

401: Missing, expired, or invalid API key.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

company_and_offering

string

required

target_customer

string

required

primary_goal

string

required

success_criteria

string

required

information_to_collect

string

required

objections_and_faqs

string

required

Response

Generated agent tone

success

enum<boolean>

required

Available options:

true

error

enum<boolean>

required

Available options:

false

statusCode

integer

required

Example:

201

message

string

required

Example:

"Success"

data

object

required

Show child attributes

timestamp

string<date-time>

required

Generate Agent Tone

curl --request POST \
  --url https://api.dialnexa.com/v1/agent-builder/generate-agent-tone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_and_offering": "Example company and offering",
  "target_customer": "Example target customer",
  "primary_goal": "Example primary goal",
  "success_criteria": "Example success criteria",
  "information_to_collect": "Example information to collect",
  "objections_and_faqs": "Example objections and faqs"
}
'

import requests

url = "https://api.dialnexa.com/v1/agent-builder/generate-agent-tone"

payload = {
    "company_and_offering": "Example company and offering",
    "target_customer": "Example target customer",
    "primary_goal": "Example primary goal",
    "success_criteria": "Example success criteria",
    "information_to_collect": "Example information to collect",
    "objections_and_faqs": "Example objections and faqs"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_and_offering: 'Example company and offering',
    target_customer: 'Example target customer',
    primary_goal: 'Example primary goal',
    success_criteria: 'Example success criteria',
    information_to_collect: 'Example information to collect',
    objections_and_faqs: 'Example objections and faqs'
  })
};

fetch('https://api.dialnexa.com/v1/agent-builder/generate-agent-tone', 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.dialnexa.com/v1/agent-builder/generate-agent-tone",
  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([
    'company_and_offering' => 'Example company and offering',
    'target_customer' => 'Example target customer',
    'primary_goal' => 'Example primary goal',
    'success_criteria' => 'Example success criteria',
    'information_to_collect' => 'Example information to collect',
    'objections_and_faqs' => 'Example objections and faqs'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.dialnexa.com/v1/agent-builder/generate-agent-tone"

	payload := strings.NewReader("{\n  \"company_and_offering\": \"Example company and offering\",\n  \"target_customer\": \"Example target customer\",\n  \"primary_goal\": \"Example primary goal\",\n  \"success_criteria\": \"Example success criteria\",\n  \"information_to_collect\": \"Example information to collect\",\n  \"objections_and_faqs\": \"Example objections and faqs\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.dialnexa.com/v1/agent-builder/generate-agent-tone")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_and_offering\": \"Example company and offering\",\n  \"target_customer\": \"Example target customer\",\n  \"primary_goal\": \"Example primary goal\",\n  \"success_criteria\": \"Example success criteria\",\n  \"information_to_collect\": \"Example information to collect\",\n  \"objections_and_faqs\": \"Example objections and faqs\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/agent-builder/generate-agent-tone")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_and_offering\": \"Example company and offering\",\n  \"target_customer\": \"Example target customer\",\n  \"primary_goal\": \"Example primary goal\",\n  \"success_criteria\": \"Example success criteria\",\n  \"information_to_collect\": \"Example information to collect\",\n  \"objections_and_faqs\": \"Example objections and faqs\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "error": false,
  "statusCode": 201,
  "message": "Success",
  "data": {
    "agent_tone": "<string>",
    "inferred_region": "<string>",
    "inferred_language": "<string>"
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

Overview

Endpoints

Before you begin

Generate Agent Tone request

Verify the result

Retry safety

Errors and recovery

Authorizations

Body

Response

​Before you begin

​Generate Agent Tone request

​Verify the result

​Retry safety

​Errors and recovery

​Related endpoints

Authorizations

Body

Response

Before you begin

Generate Agent Tone request

Verify the result

Retry safety

Errors and recovery

Related endpoints