Skip to main content
POST
Create Agent

Authorizations

Authorization
string
header
required

Company API Key

Body

application/json

Agent creation details

name
string
required

Name of the agent

type
enum<string>
required

Agent type discriminator

Available options:
chatbot
assistant_id
string

Internal assistant identifier (optional)

description
string

If present, used to generate the prompt

prompt
string

Used only if no description is provided

first_message
string

First message shown in supported chat surfaces

timezone
string

Timezone name (e.g. "America/New_York")

webhook_url
string

Webhook URL (if applicable)

branding_colour
string

"" or hex #RGB / #RRGGBB

model
string
default:gpt-4.1

Chat model name (defaults to gpt-4.1)

Response

Agent created successfully

The ID of the newly created agent