Skip to main content
POST
Create an agent

Authorizations

Authorization
string
header
required

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Body

application/json
name
string

Required on creation

Maximum string length: 255
active
boolean
default:true
use_ai
boolean
default:true
inactive_message
string | null
Maximum string length: 1000
instructions
string | null

System prompt; empty or null removes it

Maximum string length: 15000

Response

200 - application/json

Always HTTP 200: the outcome is in success and code (absolute value of the response code).

success
boolean
Example:

true

code
integer
Example:

1000

message
string
Example:

"Request success."

body
object

Endpoint payload, null when there is none

token
string | null

Present only on authentication routes

trace_id
string | null

Present only when success is false