Skip to main content
POST
Suggest Behavior

Authorizations

Authorization
string
header
required

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

Path Parameters

tenant
string | null
required

The domain of the customer

Example:

"example.com"

Body

application/json
description
string
required

A free-text description of the agent to create, used to suggest values for the behavior fields

Required string length: 1 - 10000

Response

Successful Response

The six free-text behavior fields that shape how an agent's assistant responds. Shared by Agent (where they are stored) and the behavior suggestion endpoint (which only suggests them).

audience
string | null

Who the agent serves (e.g. 'bank advisors who use AIDA to understand internal documents')

Maximum string length: 500
assistant_role
string | null

The role the assistant plays (e.g. 'an expert banking assistant that helps advisors')

Maximum string length: 500
tone
string | null

The tone of responses (e.g. 'professional, concise, supportive')

Maximum string length: 500
response_behavior
string | null

How the agent should respond (e.g. who to address, how to structure answers)

Maximum string length: 500
guardrails
string | null

Constraints the agent must respect or things it must verify before answering

Maximum string length: 500
output_format
string | null

The preferred structure or format of the answer

Maximum string length: 500