Start cloud runs of an agent from Console events. Requires --execute unless --disabled.
curl --request POST \
--url http://localhost:3000/api/v1/cloud/triggers/create \
--header 'Content-Type: application/json' \
--data '
{
"agent": "<string>",
"base": "<string>",
"batchWindow": "<string>",
"budget": "<string>",
"dailyCap": "<string>",
"dedupeWindow": "<string>",
"deliverTo": "<string>",
"disabled": true,
"events": [
"<string>"
],
"execute": true,
"mailbox": "<string>",
"project": "<string>",
"prompt": "<string>",
"site": "<string>",
"source": "<string>",
"view": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/cloud/triggers/create"
payload = {
"agent": "<string>",
"base": "<string>",
"batchWindow": "<string>",
"budget": "<string>",
"dailyCap": "<string>",
"dedupeWindow": "<string>",
"deliverTo": "<string>",
"disabled": True,
"events": ["<string>"],
"execute": True,
"mailbox": "<string>",
"project": "<string>",
"prompt": "<string>",
"site": "<string>",
"source": "<string>",
"view": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
agent: '<string>',
base: '<string>',
batchWindow: '<string>',
budget: '<string>',
dailyCap: '<string>',
dedupeWindow: '<string>',
deliverTo: '<string>',
disabled: true,
events: ['<string>'],
execute: true,
mailbox: '<string>',
project: '<string>',
prompt: '<string>',
site: '<string>',
source: '<string>',
view: '<string>'
})
};
fetch('http://localhost:3000/api/v1/cloud/triggers/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/cloud/triggers/create",
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([
'agent' => '<string>',
'base' => '<string>',
'batchWindow' => '<string>',
'budget' => '<string>',
'dailyCap' => '<string>',
'dedupeWindow' => '<string>',
'deliverTo' => '<string>',
'disabled' => true,
'events' => [
'<string>'
],
'execute' => true,
'mailbox' => '<string>',
'project' => '<string>',
'prompt' => '<string>',
'site' => '<string>',
'source' => '<string>',
'view' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://localhost:3000/api/v1/cloud/triggers/create"
payload := strings.NewReader("{\n \"agent\": \"<string>\",\n \"base\": \"<string>\",\n \"batchWindow\": \"<string>\",\n \"budget\": \"<string>\",\n \"dailyCap\": \"<string>\",\n \"dedupeWindow\": \"<string>\",\n \"deliverTo\": \"<string>\",\n \"disabled\": true,\n \"events\": [\n \"<string>\"\n ],\n \"execute\": true,\n \"mailbox\": \"<string>\",\n \"project\": \"<string>\",\n \"prompt\": \"<string>\",\n \"site\": \"<string>\",\n \"source\": \"<string>\",\n \"view\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/cloud/triggers/create")
.header("Content-Type", "application/json")
.body("{\n \"agent\": \"<string>\",\n \"base\": \"<string>\",\n \"batchWindow\": \"<string>\",\n \"budget\": \"<string>\",\n \"dailyCap\": \"<string>\",\n \"dedupeWindow\": \"<string>\",\n \"deliverTo\": \"<string>\",\n \"disabled\": true,\n \"events\": [\n \"<string>\"\n ],\n \"execute\": true,\n \"mailbox\": \"<string>\",\n \"project\": \"<string>\",\n \"prompt\": \"<string>\",\n \"site\": \"<string>\",\n \"source\": \"<string>\",\n \"view\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/cloud/triggers/create")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent\": \"<string>\",\n \"base\": \"<string>\",\n \"batchWindow\": \"<string>\",\n \"budget\": \"<string>\",\n \"dailyCap\": \"<string>\",\n \"dedupeWindow\": \"<string>\",\n \"deliverTo\": \"<string>\",\n \"disabled\": true,\n \"events\": [\n \"<string>\"\n ],\n \"execute\": true,\n \"mailbox\": \"<string>\",\n \"project\": \"<string>\",\n \"prompt\": \"<string>\",\n \"site\": \"<string>\",\n \"source\": \"<string>\",\n \"view\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"trigger": {
"actor": {
"id": "<string>",
"name": "<string>"
},
"agentId": "<string>",
"agentName": "<string>",
"batchWindowSeconds": 123,
"budgetUsd": 123,
"dailyCap": 123,
"dedupeWindowSeconds": 123,
"delivery": {
"kind": "session",
"chat": {
"channel": "<string>",
"chatId": "<string>",
"instanceId": "<string>",
"threadId": "<string>"
},
"installationId": "<string>",
"roomId": "<string>",
"sessionName": "<string>",
"siteId": "<string>"
},
"enabled": true,
"filter": {
"baseId": "<string>",
"events": [
"<string>"
],
"mailboxId": "<string>",
"siteId": "<string>",
"viewId": "<string>"
},
"firedToday": 123,
"id": "<string>",
"lastFiredAt": "<string>",
"lastRunId": "<string>",
"pausedReason": "<string>",
"pendingEvents": 123,
"projectId": "<string>",
"prompt": "<string>",
"source": "bases"
}
}cloud
Start cloud runs of an agent from Console events. Requires --execute unless --disabled.
POST
/
api
/
v1
/
cloud
/
triggers
/
create
Start cloud runs of an agent from Console events. Requires --execute unless --disabled.
curl --request POST \
--url http://localhost:3000/api/v1/cloud/triggers/create \
--header 'Content-Type: application/json' \
--data '
{
"agent": "<string>",
"base": "<string>",
"batchWindow": "<string>",
"budget": "<string>",
"dailyCap": "<string>",
"dedupeWindow": "<string>",
"deliverTo": "<string>",
"disabled": true,
"events": [
"<string>"
],
"execute": true,
"mailbox": "<string>",
"project": "<string>",
"prompt": "<string>",
"site": "<string>",
"source": "<string>",
"view": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/cloud/triggers/create"
payload = {
"agent": "<string>",
"base": "<string>",
"batchWindow": "<string>",
"budget": "<string>",
"dailyCap": "<string>",
"dedupeWindow": "<string>",
"deliverTo": "<string>",
"disabled": True,
"events": ["<string>"],
"execute": True,
"mailbox": "<string>",
"project": "<string>",
"prompt": "<string>",
"site": "<string>",
"source": "<string>",
"view": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
agent: '<string>',
base: '<string>',
batchWindow: '<string>',
budget: '<string>',
dailyCap: '<string>',
dedupeWindow: '<string>',
deliverTo: '<string>',
disabled: true,
events: ['<string>'],
execute: true,
mailbox: '<string>',
project: '<string>',
prompt: '<string>',
site: '<string>',
source: '<string>',
view: '<string>'
})
};
fetch('http://localhost:3000/api/v1/cloud/triggers/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/cloud/triggers/create",
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([
'agent' => '<string>',
'base' => '<string>',
'batchWindow' => '<string>',
'budget' => '<string>',
'dailyCap' => '<string>',
'dedupeWindow' => '<string>',
'deliverTo' => '<string>',
'disabled' => true,
'events' => [
'<string>'
],
'execute' => true,
'mailbox' => '<string>',
'project' => '<string>',
'prompt' => '<string>',
'site' => '<string>',
'source' => '<string>',
'view' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://localhost:3000/api/v1/cloud/triggers/create"
payload := strings.NewReader("{\n \"agent\": \"<string>\",\n \"base\": \"<string>\",\n \"batchWindow\": \"<string>\",\n \"budget\": \"<string>\",\n \"dailyCap\": \"<string>\",\n \"dedupeWindow\": \"<string>\",\n \"deliverTo\": \"<string>\",\n \"disabled\": true,\n \"events\": [\n \"<string>\"\n ],\n \"execute\": true,\n \"mailbox\": \"<string>\",\n \"project\": \"<string>\",\n \"prompt\": \"<string>\",\n \"site\": \"<string>\",\n \"source\": \"<string>\",\n \"view\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/cloud/triggers/create")
.header("Content-Type", "application/json")
.body("{\n \"agent\": \"<string>\",\n \"base\": \"<string>\",\n \"batchWindow\": \"<string>\",\n \"budget\": \"<string>\",\n \"dailyCap\": \"<string>\",\n \"dedupeWindow\": \"<string>\",\n \"deliverTo\": \"<string>\",\n \"disabled\": true,\n \"events\": [\n \"<string>\"\n ],\n \"execute\": true,\n \"mailbox\": \"<string>\",\n \"project\": \"<string>\",\n \"prompt\": \"<string>\",\n \"site\": \"<string>\",\n \"source\": \"<string>\",\n \"view\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/cloud/triggers/create")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent\": \"<string>\",\n \"base\": \"<string>\",\n \"batchWindow\": \"<string>\",\n \"budget\": \"<string>\",\n \"dailyCap\": \"<string>\",\n \"dedupeWindow\": \"<string>\",\n \"deliverTo\": \"<string>\",\n \"disabled\": true,\n \"events\": [\n \"<string>\"\n ],\n \"execute\": true,\n \"mailbox\": \"<string>\",\n \"project\": \"<string>\",\n \"prompt\": \"<string>\",\n \"site\": \"<string>\",\n \"source\": \"<string>\",\n \"view\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"trigger": {
"actor": {
"id": "<string>",
"name": "<string>"
},
"agentId": "<string>",
"agentName": "<string>",
"batchWindowSeconds": 123,
"budgetUsd": 123,
"dailyCap": 123,
"dedupeWindowSeconds": 123,
"delivery": {
"kind": "session",
"chat": {
"channel": "<string>",
"chatId": "<string>",
"instanceId": "<string>",
"threadId": "<string>"
},
"installationId": "<string>",
"roomId": "<string>",
"sessionName": "<string>",
"siteId": "<string>"
},
"enabled": true,
"filter": {
"baseId": "<string>",
"events": [
"<string>"
],
"mailboxId": "<string>",
"siteId": "<string>",
"viewId": "<string>"
},
"firedToday": 123,
"id": "<string>",
"lastFiredAt": "<string>",
"lastRunId": "<string>",
"pausedReason": "<string>",
"pendingEvents": 123,
"projectId": "<string>",
"prompt": "<string>",
"source": "bases"
}
}Body
application/json
Library agent slug, or a cloud agent id or name
Bases: only this base
Wait this long to batch events (0-3600, default 60)
Budget per run in US dollars (default: the agent's)
Runs per day at most (1-200, default 20)
Drop repeats of an event within (default 600)
Session that gets each result, or none
Create it disabled (applies at once)
Only these event types (comma-separated or repeated)
Create an enabled trigger (without it, print the plan and exit 3)
Mail: only this mailbox
Console project slug (default: the cwd's project)
What each run does; {{event}} is where the events go
Page comments: only this site
bases, mail, meetings or pages_comments
Bases: only rows of this view