Create a mandate
curl --request POST \
--url https://api.kairn.sh/v1/mandates \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"user_id": "user_123",
"soul": "advisor",
"role": "default",
"label": "Weekly check-in",
"task_prompt": "Review goals and write a weekly summary to memory.",
"trigger_type": "cron",
"trigger_config": {
"cron": "0 9 * * 1"
}
}
'import requests
url = "https://api.kairn.sh/v1/mandates"
payload = {
"user_id": "user_123",
"soul": "advisor",
"role": "default",
"label": "Weekly check-in",
"task_prompt": "Review goals and write a weekly summary to memory.",
"trigger_type": "cron",
"trigger_config": { "cron": "0 9 * * 1" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_id: 'user_123',
soul: 'advisor',
role: 'default',
label: 'Weekly check-in',
task_prompt: 'Review goals and write a weekly summary to memory.',
trigger_type: 'cron',
trigger_config: {cron: '0 9 * * 1'}
})
};
fetch('https://api.kairn.sh/v1/mandates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kairn.sh/v1/mandates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_id' => 'user_123',
'soul' => 'advisor',
'role' => 'default',
'label' => 'Weekly check-in',
'task_prompt' => 'Review goals and write a weekly summary to memory.',
'trigger_type' => 'cron',
'trigger_config' => [
'cron' => '0 9 * * 1'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kairn.sh/v1/mandates"
payload := strings.NewReader("{\n \"user_id\": \"user_123\",\n \"soul\": \"advisor\",\n \"role\": \"default\",\n \"label\": \"Weekly check-in\",\n \"task_prompt\": \"Review goals and write a weekly summary to memory.\",\n \"trigger_type\": \"cron\",\n \"trigger_config\": {\n \"cron\": \"0 9 * * 1\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kairn.sh/v1/mandates")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"user_123\",\n \"soul\": \"advisor\",\n \"role\": \"default\",\n \"label\": \"Weekly check-in\",\n \"task_prompt\": \"Review goals and write a weekly summary to memory.\",\n \"trigger_type\": \"cron\",\n \"trigger_config\": {\n \"cron\": \"0 9 * * 1\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kairn.sh/v1/mandates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"user_123\",\n \"soul\": \"advisor\",\n \"role\": \"default\",\n \"label\": \"Weekly check-in\",\n \"task_prompt\": \"Review goals and write a weekly summary to memory.\",\n \"trigger_type\": \"cron\",\n \"trigger_config\": {\n \"cron\": \"0 9 * * 1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tenant_id": "<string>",
"user_id": "<string>",
"soul": "<string>",
"role": "<string>",
"label": "<string>",
"task_prompt": "<string>",
"trigger_type": "cron",
"trigger_config": {},
"status": "active",
"next_run_at": "2023-11-07T05:31:56Z",
"last_run_at": "2023-11-07T05:31:56Z",
"run_count": 123,
"created_at": "2023-11-07T05:31:56Z"
}Mandates
Create a mandate
Schedule an agent to run autonomously for a user on a cron schedule. The agent has access to the user’s memory and the soul’s permissions.
POST
/
v1
/
mandates
Create a mandate
curl --request POST \
--url https://api.kairn.sh/v1/mandates \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"user_id": "user_123",
"soul": "advisor",
"role": "default",
"label": "Weekly check-in",
"task_prompt": "Review goals and write a weekly summary to memory.",
"trigger_type": "cron",
"trigger_config": {
"cron": "0 9 * * 1"
}
}
'import requests
url = "https://api.kairn.sh/v1/mandates"
payload = {
"user_id": "user_123",
"soul": "advisor",
"role": "default",
"label": "Weekly check-in",
"task_prompt": "Review goals and write a weekly summary to memory.",
"trigger_type": "cron",
"trigger_config": { "cron": "0 9 * * 1" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_id: 'user_123',
soul: 'advisor',
role: 'default',
label: 'Weekly check-in',
task_prompt: 'Review goals and write a weekly summary to memory.',
trigger_type: 'cron',
trigger_config: {cron: '0 9 * * 1'}
})
};
fetch('https://api.kairn.sh/v1/mandates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kairn.sh/v1/mandates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_id' => 'user_123',
'soul' => 'advisor',
'role' => 'default',
'label' => 'Weekly check-in',
'task_prompt' => 'Review goals and write a weekly summary to memory.',
'trigger_type' => 'cron',
'trigger_config' => [
'cron' => '0 9 * * 1'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kairn.sh/v1/mandates"
payload := strings.NewReader("{\n \"user_id\": \"user_123\",\n \"soul\": \"advisor\",\n \"role\": \"default\",\n \"label\": \"Weekly check-in\",\n \"task_prompt\": \"Review goals and write a weekly summary to memory.\",\n \"trigger_type\": \"cron\",\n \"trigger_config\": {\n \"cron\": \"0 9 * * 1\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kairn.sh/v1/mandates")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"user_123\",\n \"soul\": \"advisor\",\n \"role\": \"default\",\n \"label\": \"Weekly check-in\",\n \"task_prompt\": \"Review goals and write a weekly summary to memory.\",\n \"trigger_type\": \"cron\",\n \"trigger_config\": {\n \"cron\": \"0 9 * * 1\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kairn.sh/v1/mandates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"user_123\",\n \"soul\": \"advisor\",\n \"role\": \"default\",\n \"label\": \"Weekly check-in\",\n \"task_prompt\": \"Review goals and write a weekly summary to memory.\",\n \"trigger_type\": \"cron\",\n \"trigger_config\": {\n \"cron\": \"0 9 * * 1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tenant_id": "<string>",
"user_id": "<string>",
"soul": "<string>",
"role": "<string>",
"label": "<string>",
"task_prompt": "<string>",
"trigger_type": "cron",
"trigger_config": {},
"status": "active",
"next_run_at": "2023-11-07T05:31:56Z",
"last_run_at": "2023-11-07T05:31:56Z",
"run_count": 123,
"created_at": "2023-11-07T05:31:56Z"
}Body
application/json
Response
Mandate created.