Skip to main content
POST
Create a coaching agent

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json

Create/update payload. On update only the fields you send are changed; the template, example, and resource lists replace the existing ones when provided.

name
string
required
Maximum string length: 255
Example:

"Support Team Coach"

description
string | null
Example:

"Coaches the support team after every evaluation"

is_active
boolean
default:true
Example:

true

is_default
boolean
default:false

Send true to make this the default coach. To move the default away from an agent, set another one as default.

Example:

false

coaching_tone
string
default:supportive

supportive, direct, constructive, motivational — or your own wording, e.g. friendly but firm.

Maximum string length: 100
Example:

"supportive"

coaching_frequency
enum<string>
default:immediate

When coaching is generated. Currently immediate — after each evaluation.

Available options:
immediate
Example:

"immediate"

auto_trigger_threshold
integer
default:70

Coaching is generated automatically when an agent scores below this percentage.

Required range: 0 <= x <= 100
Example:

70

language
string
default:English

Language for coaching messages and feedback.

Maximum string length: 50
Example:

"English"

include_positive_feedback
boolean
default:true

Highlight what the agent did well.

Example:

true

include_actionable_steps
boolean
default:true

Provide specific steps for improvement.

Example:

true

include_resources
boolean
default:true

Recommend relevant training resources.

Example:

true

general_guidelines
string | null

Your coaching philosophy — applied to every coaching message.

Example:

"Always start with positive feedback. Be specific with examples."

coaching_templates
object[]

Templates for different scenarios. Sending this replaces the existing list. Leave it out on create to start with sample templates.

training_examples
object[]

Examples of your coaching style. Sending this replaces the existing list. Leave it out on create to start with a sample example.

resource_library
object[]

Training resources the AI can recommend. Sending this replaces the existing list.

Response

Coaching agent created successfully

success
boolean
Example:

true

message
string
Example:

"Coaching agent created successfully"

data
object

A coaching agent with its full configuration.