Create a scheduled task
curl --request POST \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"prompt": "<string>",
"agentId": 123,
"condition": {
"measure": "<string>",
"rule": {
"percent": 123,
"value": 123
},
"id": "<string>",
"measureTitle": "<string>",
"timeDimension": "<string>",
"timeDimensionTitle": "<string>"
},
"cronExpression": "<string>",
"description": "<string>",
"isEnabled": true,
"notification": {
"channels": {
"email": true,
"inbox": true,
"slack": true
},
"groupIds": [
123
],
"slackChannels": [
{
"id": "<string>",
"name": "<string>"
}
],
"userIds": [
123
]
},
"notificationEnabled": true,
"timezone": "<string>"
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks"
payload = {
"name": "<string>",
"prompt": "<string>",
"agentId": 123,
"condition": {
"measure": "<string>",
"rule": {
"percent": 123,
"value": 123
},
"id": "<string>",
"measureTitle": "<string>",
"timeDimension": "<string>",
"timeDimensionTitle": "<string>"
},
"cronExpression": "<string>",
"description": "<string>",
"isEnabled": True,
"notification": {
"channels": {
"email": True,
"inbox": True,
"slack": True
},
"groupIds": [123],
"slackChannels": [
{
"id": "<string>",
"name": "<string>"
}
],
"userIds": [123]
},
"notificationEnabled": True,
"timezone": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
prompt: '<string>',
agentId: 123,
condition: {
measure: '<string>',
rule: {percent: 123, value: 123},
id: '<string>',
measureTitle: '<string>',
timeDimension: '<string>',
timeDimensionTitle: '<string>'
},
cronExpression: '<string>',
description: '<string>',
isEnabled: true,
notification: {
channels: {email: true, inbox: true, slack: true},
groupIds: [123],
slackChannels: [{id: '<string>', name: '<string>'}],
userIds: [123]
},
notificationEnabled: true,
timezone: '<string>'
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks', 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://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks",
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([
'name' => '<string>',
'prompt' => '<string>',
'agentId' => 123,
'condition' => [
'measure' => '<string>',
'rule' => [
'percent' => 123,
'value' => 123
],
'id' => '<string>',
'measureTitle' => '<string>',
'timeDimension' => '<string>',
'timeDimensionTitle' => '<string>'
],
'cronExpression' => '<string>',
'description' => '<string>',
'isEnabled' => true,
'notification' => [
'channels' => [
'email' => true,
'inbox' => true,
'slack' => true
],
'groupIds' => [
123
],
'slackChannels' => [
[
'id' => '<string>',
'name' => '<string>'
]
],
'userIds' => [
123
]
],
'notificationEnabled' => true,
'timezone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agentId\": 123,\n \"condition\": {\n \"measure\": \"<string>\",\n \"rule\": {\n \"percent\": 123,\n \"value\": 123\n },\n \"id\": \"<string>\",\n \"measureTitle\": \"<string>\",\n \"timeDimension\": \"<string>\",\n \"timeDimensionTitle\": \"<string>\"\n },\n \"cronExpression\": \"<string>\",\n \"description\": \"<string>\",\n \"isEnabled\": true,\n \"notification\": {\n \"channels\": {\n \"email\": true,\n \"inbox\": true,\n \"slack\": true\n },\n \"groupIds\": [\n 123\n ],\n \"slackChannels\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"userIds\": [\n 123\n ]\n },\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agentId\": 123,\n \"condition\": {\n \"measure\": \"<string>\",\n \"rule\": {\n \"percent\": 123,\n \"value\": 123\n },\n \"id\": \"<string>\",\n \"measureTitle\": \"<string>\",\n \"timeDimension\": \"<string>\",\n \"timeDimensionTitle\": \"<string>\"\n },\n \"cronExpression\": \"<string>\",\n \"description\": \"<string>\",\n \"isEnabled\": true,\n \"notification\": {\n \"channels\": {\n \"email\": true,\n \"inbox\": true,\n \"slack\": true\n },\n \"groupIds\": [\n 123\n ],\n \"slackChannels\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"userIds\": [\n 123\n ]\n },\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agentId\": 123,\n \"condition\": {\n \"measure\": \"<string>\",\n \"rule\": {\n \"percent\": 123,\n \"value\": 123\n },\n \"id\": \"<string>\",\n \"measureTitle\": \"<string>\",\n \"timeDimension\": \"<string>\",\n \"timeDimensionTitle\": \"<string>\"\n },\n \"cronExpression\": \"<string>\",\n \"description\": \"<string>\",\n \"isEnabled\": true,\n \"notification\": {\n \"channels\": {\n \"email\": true,\n \"inbox\": true,\n \"slack\": true\n },\n \"groupIds\": [\n 123\n ],\n \"slackChannels\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"userIds\": [\n 123\n ]\n },\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deploymentId": 123,
"id": 123,
"isEnabled": true,
"name": "<string>",
"notification": {
"channels": {
"email": true,
"inbox": true,
"slack": true
},
"groupIds": [
123
],
"slackChannels": [
{
"id": "<string>",
"name": "<string>"
}
],
"userIds": [
123
],
"optedOutUserIds": [
123
]
},
"notificationEnabled": true,
"prompt": "<string>",
"timezone": "<string>",
"userId": 123,
"agentId": 123,
"condition": {
"measure": "<string>",
"rule": {
"type": "threshold",
"direction": "up",
"operator": "gt",
"percent": 123,
"value": 123
},
"granularity": "day",
"id": "<string>",
"measureTitle": "<string>",
"timeDimension": "<string>",
"timeDimensionTitle": "<string>"
},
"cronExpression": "<string>",
"description": "<string>",
"lastConditionCheck": {
"at": "<string>",
"conditionId": "<string>",
"status": "not-held",
"band": {
"high": 123,
"low": 123,
"median": 123
},
"changePercent": 123,
"notifiedAt": "<string>",
"period": "<string>",
"previous": 123,
"previousPeriod": "<string>",
"reason": "<string>",
"value": 123
},
"nextRunAt": "<string>"
}Scheduled Tasks
Create a scheduled task
POST
/
api
/
v1
/
deployments
/
{deploymentId}
/
scheduled-tasks
Create a scheduled task
curl --request POST \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"prompt": "<string>",
"agentId": 123,
"condition": {
"measure": "<string>",
"rule": {
"percent": 123,
"value": 123
},
"id": "<string>",
"measureTitle": "<string>",
"timeDimension": "<string>",
"timeDimensionTitle": "<string>"
},
"cronExpression": "<string>",
"description": "<string>",
"isEnabled": true,
"notification": {
"channels": {
"email": true,
"inbox": true,
"slack": true
},
"groupIds": [
123
],
"slackChannels": [
{
"id": "<string>",
"name": "<string>"
}
],
"userIds": [
123
]
},
"notificationEnabled": true,
"timezone": "<string>"
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks"
payload = {
"name": "<string>",
"prompt": "<string>",
"agentId": 123,
"condition": {
"measure": "<string>",
"rule": {
"percent": 123,
"value": 123
},
"id": "<string>",
"measureTitle": "<string>",
"timeDimension": "<string>",
"timeDimensionTitle": "<string>"
},
"cronExpression": "<string>",
"description": "<string>",
"isEnabled": True,
"notification": {
"channels": {
"email": True,
"inbox": True,
"slack": True
},
"groupIds": [123],
"slackChannels": [
{
"id": "<string>",
"name": "<string>"
}
],
"userIds": [123]
},
"notificationEnabled": True,
"timezone": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
prompt: '<string>',
agentId: 123,
condition: {
measure: '<string>',
rule: {percent: 123, value: 123},
id: '<string>',
measureTitle: '<string>',
timeDimension: '<string>',
timeDimensionTitle: '<string>'
},
cronExpression: '<string>',
description: '<string>',
isEnabled: true,
notification: {
channels: {email: true, inbox: true, slack: true},
groupIds: [123],
slackChannels: [{id: '<string>', name: '<string>'}],
userIds: [123]
},
notificationEnabled: true,
timezone: '<string>'
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks', 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://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks",
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([
'name' => '<string>',
'prompt' => '<string>',
'agentId' => 123,
'condition' => [
'measure' => '<string>',
'rule' => [
'percent' => 123,
'value' => 123
],
'id' => '<string>',
'measureTitle' => '<string>',
'timeDimension' => '<string>',
'timeDimensionTitle' => '<string>'
],
'cronExpression' => '<string>',
'description' => '<string>',
'isEnabled' => true,
'notification' => [
'channels' => [
'email' => true,
'inbox' => true,
'slack' => true
],
'groupIds' => [
123
],
'slackChannels' => [
[
'id' => '<string>',
'name' => '<string>'
]
],
'userIds' => [
123
]
],
'notificationEnabled' => true,
'timezone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agentId\": 123,\n \"condition\": {\n \"measure\": \"<string>\",\n \"rule\": {\n \"percent\": 123,\n \"value\": 123\n },\n \"id\": \"<string>\",\n \"measureTitle\": \"<string>\",\n \"timeDimension\": \"<string>\",\n \"timeDimensionTitle\": \"<string>\"\n },\n \"cronExpression\": \"<string>\",\n \"description\": \"<string>\",\n \"isEnabled\": true,\n \"notification\": {\n \"channels\": {\n \"email\": true,\n \"inbox\": true,\n \"slack\": true\n },\n \"groupIds\": [\n 123\n ],\n \"slackChannels\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"userIds\": [\n 123\n ]\n },\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agentId\": 123,\n \"condition\": {\n \"measure\": \"<string>\",\n \"rule\": {\n \"percent\": 123,\n \"value\": 123\n },\n \"id\": \"<string>\",\n \"measureTitle\": \"<string>\",\n \"timeDimension\": \"<string>\",\n \"timeDimensionTitle\": \"<string>\"\n },\n \"cronExpression\": \"<string>\",\n \"description\": \"<string>\",\n \"isEnabled\": true,\n \"notification\": {\n \"channels\": {\n \"email\": true,\n \"inbox\": true,\n \"slack\": true\n },\n \"groupIds\": [\n 123\n ],\n \"slackChannels\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"userIds\": [\n 123\n ]\n },\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agentId\": 123,\n \"condition\": {\n \"measure\": \"<string>\",\n \"rule\": {\n \"percent\": 123,\n \"value\": 123\n },\n \"id\": \"<string>\",\n \"measureTitle\": \"<string>\",\n \"timeDimension\": \"<string>\",\n \"timeDimensionTitle\": \"<string>\"\n },\n \"cronExpression\": \"<string>\",\n \"description\": \"<string>\",\n \"isEnabled\": true,\n \"notification\": {\n \"channels\": {\n \"email\": true,\n \"inbox\": true,\n \"slack\": true\n },\n \"groupIds\": [\n 123\n ],\n \"slackChannels\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"userIds\": [\n 123\n ]\n },\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deploymentId": 123,
"id": 123,
"isEnabled": true,
"name": "<string>",
"notification": {
"channels": {
"email": true,
"inbox": true,
"slack": true
},
"groupIds": [
123
],
"slackChannels": [
{
"id": "<string>",
"name": "<string>"
}
],
"userIds": [
123
],
"optedOutUserIds": [
123
]
},
"notificationEnabled": true,
"prompt": "<string>",
"timezone": "<string>",
"userId": 123,
"agentId": 123,
"condition": {
"measure": "<string>",
"rule": {
"type": "threshold",
"direction": "up",
"operator": "gt",
"percent": 123,
"value": 123
},
"granularity": "day",
"id": "<string>",
"measureTitle": "<string>",
"timeDimension": "<string>",
"timeDimensionTitle": "<string>"
},
"cronExpression": "<string>",
"description": "<string>",
"lastConditionCheck": {
"at": "<string>",
"conditionId": "<string>",
"status": "not-held",
"band": {
"high": 123,
"low": 123,
"median": 123
},
"changePercent": 123,
"notifiedAt": "<string>",
"period": "<string>",
"previous": 123,
"previousPeriod": "<string>",
"reason": "<string>",
"value": 123
},
"nextRunAt": "<string>"
}Saves a prompt the agent runs as the caller on
cronExpression in timezone, or on demand. Needs ScheduledTasksCreate (403 otherwise). A cron fires at most hourly (400 otherwise), and a user can have 20 active tasks (409 past that).Authorizations
Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.
Path Parameters
Body
application/json
CreateScheduledTaskInput
Required string length:
1 - 255What the agent is asked on every run, shown as the task's Instructions in Cube. Each run starts a new chat thread with no memory of earlier ones, so write the whole request.
Minimum string length:
1The agent that runs the task. Omit for the deployment default.
Notify only when: on each fire the measure is read once, before the agent runs, and the agent runs only when the condition starts to hold, with the crossing facts at the top of its thread; it runs again only after the condition has stopped holding. A change or anomaly rule needs timeDimension and granularity. A request that sends notification must leave a task with a condition notifying someone (400 otherwise); one that does not, on the deprecated notificationEnabled shape, keeps its earlier behaviour. Omit to run the agent on every fire.
Show child attributes
Show child attributes
Standard 5-field cron (minute hour day-of-month month day-of-week), e.g. 0 9 * * 1-5 for 9:00 on weekdays. A task runs at most once an hour, so the minute field is a single number. Null or omitted makes the task Manual: it runs only when started with POST /scheduled-tasks/{taskId}/run.
Maximum string length:
100Create the schedule paused with false. Defaults to true.
Who a finished run notifies, and how. Replaces the stored setting. Picked users and groups are shared the task, view-only, so they can open the run. An id that is not an active workspace member or a group answers 400. Wins over notificationEnabled when both are sent. Omit it, and notificationEnabled, to notify nobody.
Show child attributes
Show child attributes
Deprecated: send notification instead. true adds the creator to notification with Inbox on; false takes the creator off it only when they get Inbox, so a creator who gets only Email keeps it.
IANA time zone the cron is read in, e.g. America/New_York. Defaults to UTC.
Maximum string length:
100Response
200 - application/json
False while the schedule is paused.
Who a finished run notifies, and how.
Show child attributes
Show child attributes
Deprecated: read notification instead. Whether a finished run notifies the creator in Cube's notification inbox.
What the agent is asked on every run, shown as the task's Instructions in Cube. Each run starts a new chat thread, so the prompt has to stand on its own.
IANA time zone the cron is read in, e.g. America/New_York. Defaults to UTC.
The creator. Every run executes as this user, and only they or an admin may change, delete or run the task.
The agent that runs the task; null runs the deployment default.
Notify only when: on each fire the measure is read once, before the agent runs, and the agent runs only when the condition starts to hold, with the crossing facts at the top of its thread; it runs again only after the condition has stopped holding. A change or anomaly rule needs timeDimension and granularity. A request that sends notification must leave a task with a condition notifying someone (400 otherwise); one that does not, on the deprecated notificationEnabled shape, keeps its earlier behaviour. Null runs the agent on every fire.
Show child attributes
Show child attributes
Standard 5-field cron (minute hour day-of-month month day-of-week), e.g. 0 9 * * 1-5 for 9:00 on weekdays. Null when the task is Manual: it runs only when started with POST /scheduled-tasks/{taskId}/run.
The latest condition check; null before the first one.
Show child attributes
Show child attributes
When the schedule next fires (ISO 8601, UTC); null for a Manual or paused task.