Skip to main content
POST
Create a mandate

Authorizations

X-API-Key
string
header
required

Body

application/json
user_id
string
required
Example:

"user_123"

soul
string
required
Example:

"advisor"

role
string
default:default
required
label
string
required
Example:

"Weekly check-in"

task_prompt
string
required

The task the agent will execute each time the mandate fires.

Example:

"Review goals and write a weekly summary to memory."

trigger_type
enum<string>
required
Available options:
cron
Example:

"cron"

trigger_config
object

Response

Mandate created.

id
string
tenant_id
string
user_id
string
soul
string
role
string
label
string
task_prompt
string
trigger_type
enum<string>
Available options:
cron,
event
trigger_config
object
status
enum<string>
Available options:
active,
paused,
cancelled
next_run_at
string<date-time> | null
last_run_at
string<date-time> | null
run_count
integer
created_at
string<date-time>