Generate Agent Objectives

POST

agent-builder

generate-objectives

curl --request POST \
  --url https://api.dialnexa.com/v1/agent-builder/generate-objectives \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_and_offering": "Acme Corp - B2B payroll software for mid-market HR teams.",
  "target_customer": "HR directors at 200-2,000 employee companies evaluating payroll vendors.",
  "primary_goal": "Book demos and answer pricing and onboarding questions."
}
'

import requests

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

payload = {
    "company_and_offering": "Acme Corp - B2B payroll software for mid-market HR teams.",
    "target_customer": "HR directors at 200-2,000 employee companies evaluating payroll vendors.",
    "primary_goal": "Book demos and answer pricing and onboarding questions."
}
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: 'Acme Corp - B2B payroll software for mid-market HR teams.',
    target_customer: 'HR directors at 200-2,000 employee companies evaluating payroll vendors.',
    primary_goal: 'Book demos and answer pricing and onboarding questions.'
  })
};

fetch('https://api.dialnexa.com/v1/agent-builder/generate-objectives', 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-objectives",
  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' => 'Acme Corp - B2B payroll software for mid-market HR teams.',
    'target_customer' => 'HR directors at 200-2,000 employee companies evaluating payroll vendors.',
    'primary_goal' => 'Book demos and answer pricing and onboarding questions.'
  ]),
  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-objectives"

	payload := strings.NewReader("{\n  \"company_and_offering\": \"Acme Corp - B2B payroll software for mid-market HR teams.\",\n  \"target_customer\": \"HR directors at 200-2,000 employee companies evaluating payroll vendors.\",\n  \"primary_goal\": \"Book demos and answer pricing and onboarding questions.\"\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-objectives")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_and_offering\": \"Acme Corp - B2B payroll software for mid-market HR teams.\",\n  \"target_customer\": \"HR directors at 200-2,000 employee companies evaluating payroll vendors.\",\n  \"primary_goal\": \"Book demos and answer pricing and onboarding questions.\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"Acme Corp - B2B payroll software for mid-market HR teams.\",\n  \"target_customer\": \"HR directors at 200-2,000 employee companies evaluating payroll vendors.\",\n  \"primary_goal\": \"Book demos and answer pricing and onboarding questions.\"\n}"

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

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

{
  "statusCode": 400,
  "error": true,
  "success": false,
  "data": [],
  "message": "The given information does not contain enough details to build an agent. Tell us what you offer, who you serve, and what the agent should do.",
  "errors": [
    "The given information does not contain enough details to build an agent. Tell us what you offer, who you serve, and what the agent should do."
  ]
}

{
  "statusCode": 401,
  "error": true,
  "success": false,
  "data": [],
  "message": "Invalid API key",
  "errors": []
}

{
  "statusCode": 500,
  "error": true,
  "success": false,
  "data": [],
  "message": "Internal server error",
  "errors": []
}

Read only Generate Agent Objectives uses your workspace API key. Drafts call objectives from your company and customer context without changing an agent.

Before you begin

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

Generate Agent Objectives 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-objectives' \
  --header "Authorization: Bearer $DIALNEXA_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "company_and_offering": "Acme Corp - B2B payroll software for mid-market HR teams.",
  "target_customer": "HR directors at 200-2,000 employee companies evaluating payroll vendors.",
  "primary_goal": "Book demos and answer pricing and onboarding questions."
}'

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

400: A field is missing or empty, the context does not contain enough detail to draft objectives (“The given information does not contain enough details to build an agent…”), or no success criteria could be generated. Add detail about what you offer, who you serve, and what the agent should do, then retry.
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

Company name and what the business offers

Example:

"Acme Corp - B2B payroll software for mid-market HR teams."

target_customer

string

required

Who the agent will speak with

Example:

"HR directors at 200-2,000 employee companies evaluating payroll vendors."

primary_goal

string

required

Primary outcome the agent should achieve on each call

Example:

"Book demos and answer pricing and onboarding questions."

Response

Generated objectives fields

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 Objectives

curl --request POST \
  --url https://api.dialnexa.com/v1/agent-builder/generate-objectives \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_and_offering": "Acme Corp - B2B payroll software for mid-market HR teams.",
  "target_customer": "HR directors at 200-2,000 employee companies evaluating payroll vendors.",
  "primary_goal": "Book demos and answer pricing and onboarding questions."
}
'

import requests

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

payload = {
    "company_and_offering": "Acme Corp - B2B payroll software for mid-market HR teams.",
    "target_customer": "HR directors at 200-2,000 employee companies evaluating payroll vendors.",
    "primary_goal": "Book demos and answer pricing and onboarding questions."
}
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: 'Acme Corp - B2B payroll software for mid-market HR teams.',
    target_customer: 'HR directors at 200-2,000 employee companies evaluating payroll vendors.',
    primary_goal: 'Book demos and answer pricing and onboarding questions.'
  })
};

fetch('https://api.dialnexa.com/v1/agent-builder/generate-objectives', 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-objectives",
  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' => 'Acme Corp - B2B payroll software for mid-market HR teams.',
    'target_customer' => 'HR directors at 200-2,000 employee companies evaluating payroll vendors.',
    'primary_goal' => 'Book demos and answer pricing and onboarding questions.'
  ]),
  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-objectives"

	payload := strings.NewReader("{\n  \"company_and_offering\": \"Acme Corp - B2B payroll software for mid-market HR teams.\",\n  \"target_customer\": \"HR directors at 200-2,000 employee companies evaluating payroll vendors.\",\n  \"primary_goal\": \"Book demos and answer pricing and onboarding questions.\"\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-objectives")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_and_offering\": \"Acme Corp - B2B payroll software for mid-market HR teams.\",\n  \"target_customer\": \"HR directors at 200-2,000 employee companies evaluating payroll vendors.\",\n  \"primary_goal\": \"Book demos and answer pricing and onboarding questions.\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"Acme Corp - B2B payroll software for mid-market HR teams.\",\n  \"target_customer\": \"HR directors at 200-2,000 employee companies evaluating payroll vendors.\",\n  \"primary_goal\": \"Book demos and answer pricing and onboarding questions.\"\n}"

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

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

{
  "statusCode": 400,
  "error": true,
  "success": false,
  "data": [],
  "message": "The given information does not contain enough details to build an agent. Tell us what you offer, who you serve, and what the agent should do.",
  "errors": [
    "The given information does not contain enough details to build an agent. Tell us what you offer, who you serve, and what the agent should do."
  ]
}

{
  "statusCode": 401,
  "error": true,
  "success": false,
  "data": [],
  "message": "Invalid API key",
  "errors": []
}

{
  "statusCode": 500,
  "error": true,
  "success": false,
  "data": [],
  "message": "Internal server error",
  "errors": []
}

Overview

Endpoints

Before you begin

Generate Agent Objectives request

Verify the result

Retry safety

Errors and recovery

Authorizations

Body

Response

​Before you begin

​Generate Agent Objectives request

​Verify the result

​Retry safety

​Errors and recovery

​Related endpoints

Authorizations

Body

Response

Before you begin

Generate Agent Objectives request

Verify the result

Retry safety

Errors and recovery

Related endpoints