Skip to main content
POST
Create Agent

Headers

x-anyreach-org
string | null

Organization ID for user PATs (pat_ prefix tokens)

Body

application/json

Schema for API requests to create a new agent (excludes organization_id).

name
string
required
description
string | null
default:""
active
boolean | null
default:true
is_demo
boolean | null
default:false
metadata
Metadata · object | null

Response

Successful Response

Agent entity representing an agent configuration.

id
string
required
organization_id
string
required
name
string
required
description
string
required
active
boolean
required
is_demo
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
metadata
Metadata · object | null
created_by
string | null
modified_by
string | null