Create Task
curl --request POST \
--url https://api.boostgpt.co/v1/bot/tasks/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"bot_id": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"schedule_config": {},
"timezone": "<string>",
"active_hours_start": "<string>",
"active_hours_end": "<string>",
"max_executions": 123,
"chat_mode": "<string>",
"chat_id": "<string>",
"assignee_type": "<string>",
"assignee_id": "<string>",
"tags": [
"<string>"
],
"attachments": [
{}
]
}
'import requests
url = "https://api.boostgpt.co/v1/bot/tasks/create"
payload = {
"project_id": "<string>",
"bot_id": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"schedule_config": {},
"timezone": "<string>",
"active_hours_start": "<string>",
"active_hours_end": "<string>",
"max_executions": 123,
"chat_mode": "<string>",
"chat_id": "<string>",
"assignee_type": "<string>",
"assignee_id": "<string>",
"tags": ["<string>"],
"attachments": [{}]
}
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({
project_id: '<string>',
bot_id: '<string>',
name: '<string>',
prompt: '<string>',
description: '<string>',
schedule_config: {},
timezone: '<string>',
active_hours_start: '<string>',
active_hours_end: '<string>',
max_executions: 123,
chat_mode: '<string>',
chat_id: '<string>',
assignee_type: '<string>',
assignee_id: '<string>',
tags: ['<string>'],
attachments: [{}]
})
};
fetch('https://api.boostgpt.co/v1/bot/tasks/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_URL => "https://api.boostgpt.co/v1/bot/tasks/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([
'project_id' => '<string>',
'bot_id' => '<string>',
'name' => '<string>',
'prompt' => '<string>',
'description' => '<string>',
'schedule_config' => [
],
'timezone' => '<string>',
'active_hours_start' => '<string>',
'active_hours_end' => '<string>',
'max_executions' => 123,
'chat_mode' => '<string>',
'chat_id' => '<string>',
'assignee_type' => '<string>',
'assignee_id' => '<string>',
'tags' => [
'<string>'
],
'attachments' => [
[
]
]
]),
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://api.boostgpt.co/v1/bot/tasks/create"
payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"schedule_config\": {},\n \"timezone\": \"<string>\",\n \"active_hours_start\": \"<string>\",\n \"active_hours_end\": \"<string>\",\n \"max_executions\": 123,\n \"chat_mode\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"assignee_type\": \"<string>\",\n \"assignee_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attachments\": [\n {}\n ]\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://api.boostgpt.co/v1/bot/tasks/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"schedule_config\": {},\n \"timezone\": \"<string>\",\n \"active_hours_start\": \"<string>\",\n \"active_hours_end\": \"<string>\",\n \"max_executions\": 123,\n \"chat_mode\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"assignee_type\": \"<string>\",\n \"assignee_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attachments\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.boostgpt.co/v1/bot/tasks/create")
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 \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"schedule_config\": {},\n \"timezone\": \"<string>\",\n \"active_hours_start\": \"<string>\",\n \"active_hours_end\": \"<string>\",\n \"max_executions\": 123,\n \"chat_mode\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"assignee_type\": \"<string>\",\n \"assignee_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attachments\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"task": {
"uuid": "<string>",
"bot_id": "<string>",
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"purpose": "<string>",
"schedule_type": "once",
"schedule_config": {},
"timezone": "<string>",
"enabled": true,
"state": "<string>",
"autonomy": "<string>",
"chat_mode": "<string>",
"active_hours_start": "<string>",
"active_hours_end": "<string>",
"execution_count": 123,
"max_executions": 123,
"error_count": 123,
"max_consecutive_errors": 123,
"last_executed_at": "2023-11-07T05:31:56Z",
"last_status": "<string>",
"last_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Tasks
Create Task
Create a scheduled task for an agent. Replaces bot/heartbeat/configure — a heartbeat was a task with a cron.
POST
/
v1
/
bot
/
tasks
/
create
Create Task
curl --request POST \
--url https://api.boostgpt.co/v1/bot/tasks/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"bot_id": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"schedule_config": {},
"timezone": "<string>",
"active_hours_start": "<string>",
"active_hours_end": "<string>",
"max_executions": 123,
"chat_mode": "<string>",
"chat_id": "<string>",
"assignee_type": "<string>",
"assignee_id": "<string>",
"tags": [
"<string>"
],
"attachments": [
{}
]
}
'import requests
url = "https://api.boostgpt.co/v1/bot/tasks/create"
payload = {
"project_id": "<string>",
"bot_id": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"schedule_config": {},
"timezone": "<string>",
"active_hours_start": "<string>",
"active_hours_end": "<string>",
"max_executions": 123,
"chat_mode": "<string>",
"chat_id": "<string>",
"assignee_type": "<string>",
"assignee_id": "<string>",
"tags": ["<string>"],
"attachments": [{}]
}
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({
project_id: '<string>',
bot_id: '<string>',
name: '<string>',
prompt: '<string>',
description: '<string>',
schedule_config: {},
timezone: '<string>',
active_hours_start: '<string>',
active_hours_end: '<string>',
max_executions: 123,
chat_mode: '<string>',
chat_id: '<string>',
assignee_type: '<string>',
assignee_id: '<string>',
tags: ['<string>'],
attachments: [{}]
})
};
fetch('https://api.boostgpt.co/v1/bot/tasks/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_URL => "https://api.boostgpt.co/v1/bot/tasks/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([
'project_id' => '<string>',
'bot_id' => '<string>',
'name' => '<string>',
'prompt' => '<string>',
'description' => '<string>',
'schedule_config' => [
],
'timezone' => '<string>',
'active_hours_start' => '<string>',
'active_hours_end' => '<string>',
'max_executions' => 123,
'chat_mode' => '<string>',
'chat_id' => '<string>',
'assignee_type' => '<string>',
'assignee_id' => '<string>',
'tags' => [
'<string>'
],
'attachments' => [
[
]
]
]),
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://api.boostgpt.co/v1/bot/tasks/create"
payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"schedule_config\": {},\n \"timezone\": \"<string>\",\n \"active_hours_start\": \"<string>\",\n \"active_hours_end\": \"<string>\",\n \"max_executions\": 123,\n \"chat_mode\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"assignee_type\": \"<string>\",\n \"assignee_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attachments\": [\n {}\n ]\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://api.boostgpt.co/v1/bot/tasks/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"schedule_config\": {},\n \"timezone\": \"<string>\",\n \"active_hours_start\": \"<string>\",\n \"active_hours_end\": \"<string>\",\n \"max_executions\": 123,\n \"chat_mode\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"assignee_type\": \"<string>\",\n \"assignee_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attachments\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.boostgpt.co/v1/bot/tasks/create")
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 \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"schedule_config\": {},\n \"timezone\": \"<string>\",\n \"active_hours_start\": \"<string>\",\n \"active_hours_end\": \"<string>\",\n \"max_executions\": 123,\n \"chat_mode\": \"<string>\",\n \"chat_id\": \"<string>\",\n \"assignee_type\": \"<string>\",\n \"assignee_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attachments\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"task": {
"uuid": "<string>",
"bot_id": "<string>",
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"purpose": "<string>",
"schedule_type": "once",
"schedule_config": {},
"timezone": "<string>",
"enabled": true,
"state": "<string>",
"autonomy": "<string>",
"chat_mode": "<string>",
"active_hours_start": "<string>",
"active_hours_end": "<string>",
"execution_count": 123,
"max_executions": 123,
"error_count": 123,
"max_consecutive_errors": 123,
"last_executed_at": "2023-11-07T05:31:56Z",
"last_status": "<string>",
"last_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Enter your API key
Body
application/json
Project ID
Agent ID
Task name, shown on the board
What the agent should do each run
Optional longer description
How the task repeats. interval uses schedule_config.interval_minutes; cron uses schedule_config.cron.
Available options:
once, daily, weekly, monthly, interval, cron Shape depends on schedule_type: { interval_minutes }, { time }, { day, time }, { day_of_month, time } or { cron }.
IANA timezone, e.g. Europe/London
Only run at or after this time, HH:MM
Only run before this time, HH:MM
Stop after this many runs. Omit for unlimited.
Conversation mode the run uses
Bind the task to a Site's builder conversation
agent or member
UUID of the assignee
Response
200 - application/json
The created task
Show child attributes
Show child attributes
Was this page helpful?
⌘I