Skip to main content
POST
Generate Agent Objectives
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.

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

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
timestamp
string<date-time>
required