Create a scheduled task for an AI employee.
curl --request POST \
--url https://api.parallellabs.app/api/v0/scheduled-tasks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"employeeId": "<string>",
"name": "<string>",
"prompt": "<string>",
"companyId": "<string>",
"scheduledAt": "<string>",
"recurringConfig": {
"time": "<string>",
"daysOfWeek": [
123
],
"dayOfMonth": 123,
"activeHoursStart": "<string>",
"activeHoursEnd": "<string>"
},
"timezone": "<string>",
"contextSettings": {
"model": "<string>",
"temperature": 123,
"shortTermMemories": true,
"longTermMemories": true,
"documents": true,
"documentStrategy": "<string>",
"documentPath": "<string>",
"requestDocuments": [
{}
],
"searchEngine": true,
"websites": true,
"websitesJs": true,
"news": true,
"company": true,
"employee": true,
"responseInstructions": true,
"image": "<string>",
"lists": true,
"browserTask": {},
"researchTask": true,
"documentCreation": true,
"sleepTool": true,
"canvasTool": true,
"mcpServers": [
"<string>"
],
"composioTools": [
"<string>"
],
"toolRouter": true,
"audienceTools": true,
"voiceId": "<string>"
},
"templateId": "<string>",
"templateVersion": 123
}
'import requests
url = "https://api.parallellabs.app/api/v0/scheduled-tasks"
payload = {
"employeeId": "<string>",
"name": "<string>",
"prompt": "<string>",
"companyId": "<string>",
"scheduledAt": "<string>",
"recurringConfig": {
"time": "<string>",
"daysOfWeek": [123],
"dayOfMonth": 123,
"activeHoursStart": "<string>",
"activeHoursEnd": "<string>"
},
"timezone": "<string>",
"contextSettings": {
"model": "<string>",
"temperature": 123,
"shortTermMemories": True,
"longTermMemories": True,
"documents": True,
"documentStrategy": "<string>",
"documentPath": "<string>",
"requestDocuments": [{}],
"searchEngine": True,
"websites": True,
"websitesJs": True,
"news": True,
"company": True,
"employee": True,
"responseInstructions": True,
"image": "<string>",
"lists": True,
"browserTask": {},
"researchTask": True,
"documentCreation": True,
"sleepTool": True,
"canvasTool": True,
"mcpServers": ["<string>"],
"composioTools": ["<string>"],
"toolRouter": True,
"audienceTools": True,
"voiceId": "<string>"
},
"templateId": "<string>",
"templateVersion": 123
}
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({
employeeId: '<string>',
name: '<string>',
prompt: '<string>',
companyId: '<string>',
scheduledAt: '<string>',
recurringConfig: {
time: '<string>',
daysOfWeek: [123],
dayOfMonth: 123,
activeHoursStart: '<string>',
activeHoursEnd: '<string>'
},
timezone: '<string>',
contextSettings: {
model: '<string>',
temperature: 123,
shortTermMemories: true,
longTermMemories: true,
documents: true,
documentStrategy: '<string>',
documentPath: '<string>',
requestDocuments: [{}],
searchEngine: true,
websites: true,
websitesJs: true,
news: true,
company: true,
employee: true,
responseInstructions: true,
image: '<string>',
lists: true,
browserTask: {},
researchTask: true,
documentCreation: true,
sleepTool: true,
canvasTool: true,
mcpServers: ['<string>'],
composioTools: ['<string>'],
toolRouter: true,
audienceTools: true,
voiceId: '<string>'
},
templateId: '<string>',
templateVersion: 123
})
};
fetch('https://api.parallellabs.app/api/v0/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://api.parallellabs.app/api/v0/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([
'employeeId' => '<string>',
'name' => '<string>',
'prompt' => '<string>',
'companyId' => '<string>',
'scheduledAt' => '<string>',
'recurringConfig' => [
'time' => '<string>',
'daysOfWeek' => [
123
],
'dayOfMonth' => 123,
'activeHoursStart' => '<string>',
'activeHoursEnd' => '<string>'
],
'timezone' => '<string>',
'contextSettings' => [
'model' => '<string>',
'temperature' => 123,
'shortTermMemories' => true,
'longTermMemories' => true,
'documents' => true,
'documentStrategy' => '<string>',
'documentPath' => '<string>',
'requestDocuments' => [
[
]
],
'searchEngine' => true,
'websites' => true,
'websitesJs' => true,
'news' => true,
'company' => true,
'employee' => true,
'responseInstructions' => true,
'image' => '<string>',
'lists' => true,
'browserTask' => [
],
'researchTask' => true,
'documentCreation' => true,
'sleepTool' => true,
'canvasTool' => true,
'mcpServers' => [
'<string>'
],
'composioTools' => [
'<string>'
],
'toolRouter' => true,
'audienceTools' => true,
'voiceId' => '<string>'
],
'templateId' => '<string>',
'templateVersion' => 123
]),
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.parallellabs.app/api/v0/scheduled-tasks"
payload := strings.NewReader("{\n \"employeeId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"companyId\": \"<string>\",\n \"scheduledAt\": \"<string>\",\n \"recurringConfig\": {\n \"time\": \"<string>\",\n \"daysOfWeek\": [\n 123\n ],\n \"dayOfMonth\": 123,\n \"activeHoursStart\": \"<string>\",\n \"activeHoursEnd\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"contextSettings\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"shortTermMemories\": true,\n \"longTermMemories\": true,\n \"documents\": true,\n \"documentStrategy\": \"<string>\",\n \"documentPath\": \"<string>\",\n \"requestDocuments\": [\n {}\n ],\n \"searchEngine\": true,\n \"websites\": true,\n \"websitesJs\": true,\n \"news\": true,\n \"company\": true,\n \"employee\": true,\n \"responseInstructions\": true,\n \"image\": \"<string>\",\n \"lists\": true,\n \"browserTask\": {},\n \"researchTask\": true,\n \"documentCreation\": true,\n \"sleepTool\": true,\n \"canvasTool\": true,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"composioTools\": [\n \"<string>\"\n ],\n \"toolRouter\": true,\n \"audienceTools\": true,\n \"voiceId\": \"<string>\"\n },\n \"templateId\": \"<string>\",\n \"templateVersion\": 123\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.parallellabs.app/api/v0/scheduled-tasks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employeeId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"companyId\": \"<string>\",\n \"scheduledAt\": \"<string>\",\n \"recurringConfig\": {\n \"time\": \"<string>\",\n \"daysOfWeek\": [\n 123\n ],\n \"dayOfMonth\": 123,\n \"activeHoursStart\": \"<string>\",\n \"activeHoursEnd\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"contextSettings\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"shortTermMemories\": true,\n \"longTermMemories\": true,\n \"documents\": true,\n \"documentStrategy\": \"<string>\",\n \"documentPath\": \"<string>\",\n \"requestDocuments\": [\n {}\n ],\n \"searchEngine\": true,\n \"websites\": true,\n \"websitesJs\": true,\n \"news\": true,\n \"company\": true,\n \"employee\": true,\n \"responseInstructions\": true,\n \"image\": \"<string>\",\n \"lists\": true,\n \"browserTask\": {},\n \"researchTask\": true,\n \"documentCreation\": true,\n \"sleepTool\": true,\n \"canvasTool\": true,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"composioTools\": [\n \"<string>\"\n ],\n \"toolRouter\": true,\n \"audienceTools\": true,\n \"voiceId\": \"<string>\"\n },\n \"templateId\": \"<string>\",\n \"templateVersion\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/scheduled-tasks")
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 \"employeeId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"companyId\": \"<string>\",\n \"scheduledAt\": \"<string>\",\n \"recurringConfig\": {\n \"time\": \"<string>\",\n \"daysOfWeek\": [\n 123\n ],\n \"dayOfMonth\": 123,\n \"activeHoursStart\": \"<string>\",\n \"activeHoursEnd\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"contextSettings\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"shortTermMemories\": true,\n \"longTermMemories\": true,\n \"documents\": true,\n \"documentStrategy\": \"<string>\",\n \"documentPath\": \"<string>\",\n \"requestDocuments\": [\n {}\n ],\n \"searchEngine\": true,\n \"websites\": true,\n \"websitesJs\": true,\n \"news\": true,\n \"company\": true,\n \"employee\": true,\n \"responseInstructions\": true,\n \"image\": \"<string>\",\n \"lists\": true,\n \"browserTask\": {},\n \"researchTask\": true,\n \"documentCreation\": true,\n \"sleepTool\": true,\n \"canvasTool\": true,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"composioTools\": [\n \"<string>\"\n ],\n \"toolRouter\": true,\n \"audienceTools\": true,\n \"voiceId\": \"<string>\"\n },\n \"templateId\": \"<string>\",\n \"templateVersion\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"companyId": "<string>",
"userId": "<string>",
"employeeId": "<string>",
"name": "<string>",
"prompt": "<string>",
"scheduleType": "<string>",
"scheduledAt": "<string>",
"recurringConfig": {},
"contextSettings": {},
"timezone": "<string>",
"nextRunAt": "<string>",
"lastRunAt": "<string>",
"status": "<string>",
"runCount": 123,
"templateId": "<string>",
"templateVersion": 123,
"createdDate": "<string>",
"updatedDate": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Scheduled Tasks
Create a scheduled task for an AI employee.
scheduleType is one_time (needs scheduledAt), recurring (needs recurringConfig.frequency and time) or heartbeat (needs recurringConfig.interval, optionally activeHoursStart/activeHoursEnd and daysOfWeek). The task runs with the employee’s chat settings unless contextSettings is given.
POST
/
api
/
v0
/
scheduled-tasks
Create a scheduled task for an AI employee.
curl --request POST \
--url https://api.parallellabs.app/api/v0/scheduled-tasks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"employeeId": "<string>",
"name": "<string>",
"prompt": "<string>",
"companyId": "<string>",
"scheduledAt": "<string>",
"recurringConfig": {
"time": "<string>",
"daysOfWeek": [
123
],
"dayOfMonth": 123,
"activeHoursStart": "<string>",
"activeHoursEnd": "<string>"
},
"timezone": "<string>",
"contextSettings": {
"model": "<string>",
"temperature": 123,
"shortTermMemories": true,
"longTermMemories": true,
"documents": true,
"documentStrategy": "<string>",
"documentPath": "<string>",
"requestDocuments": [
{}
],
"searchEngine": true,
"websites": true,
"websitesJs": true,
"news": true,
"company": true,
"employee": true,
"responseInstructions": true,
"image": "<string>",
"lists": true,
"browserTask": {},
"researchTask": true,
"documentCreation": true,
"sleepTool": true,
"canvasTool": true,
"mcpServers": [
"<string>"
],
"composioTools": [
"<string>"
],
"toolRouter": true,
"audienceTools": true,
"voiceId": "<string>"
},
"templateId": "<string>",
"templateVersion": 123
}
'import requests
url = "https://api.parallellabs.app/api/v0/scheduled-tasks"
payload = {
"employeeId": "<string>",
"name": "<string>",
"prompt": "<string>",
"companyId": "<string>",
"scheduledAt": "<string>",
"recurringConfig": {
"time": "<string>",
"daysOfWeek": [123],
"dayOfMonth": 123,
"activeHoursStart": "<string>",
"activeHoursEnd": "<string>"
},
"timezone": "<string>",
"contextSettings": {
"model": "<string>",
"temperature": 123,
"shortTermMemories": True,
"longTermMemories": True,
"documents": True,
"documentStrategy": "<string>",
"documentPath": "<string>",
"requestDocuments": [{}],
"searchEngine": True,
"websites": True,
"websitesJs": True,
"news": True,
"company": True,
"employee": True,
"responseInstructions": True,
"image": "<string>",
"lists": True,
"browserTask": {},
"researchTask": True,
"documentCreation": True,
"sleepTool": True,
"canvasTool": True,
"mcpServers": ["<string>"],
"composioTools": ["<string>"],
"toolRouter": True,
"audienceTools": True,
"voiceId": "<string>"
},
"templateId": "<string>",
"templateVersion": 123
}
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({
employeeId: '<string>',
name: '<string>',
prompt: '<string>',
companyId: '<string>',
scheduledAt: '<string>',
recurringConfig: {
time: '<string>',
daysOfWeek: [123],
dayOfMonth: 123,
activeHoursStart: '<string>',
activeHoursEnd: '<string>'
},
timezone: '<string>',
contextSettings: {
model: '<string>',
temperature: 123,
shortTermMemories: true,
longTermMemories: true,
documents: true,
documentStrategy: '<string>',
documentPath: '<string>',
requestDocuments: [{}],
searchEngine: true,
websites: true,
websitesJs: true,
news: true,
company: true,
employee: true,
responseInstructions: true,
image: '<string>',
lists: true,
browserTask: {},
researchTask: true,
documentCreation: true,
sleepTool: true,
canvasTool: true,
mcpServers: ['<string>'],
composioTools: ['<string>'],
toolRouter: true,
audienceTools: true,
voiceId: '<string>'
},
templateId: '<string>',
templateVersion: 123
})
};
fetch('https://api.parallellabs.app/api/v0/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://api.parallellabs.app/api/v0/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([
'employeeId' => '<string>',
'name' => '<string>',
'prompt' => '<string>',
'companyId' => '<string>',
'scheduledAt' => '<string>',
'recurringConfig' => [
'time' => '<string>',
'daysOfWeek' => [
123
],
'dayOfMonth' => 123,
'activeHoursStart' => '<string>',
'activeHoursEnd' => '<string>'
],
'timezone' => '<string>',
'contextSettings' => [
'model' => '<string>',
'temperature' => 123,
'shortTermMemories' => true,
'longTermMemories' => true,
'documents' => true,
'documentStrategy' => '<string>',
'documentPath' => '<string>',
'requestDocuments' => [
[
]
],
'searchEngine' => true,
'websites' => true,
'websitesJs' => true,
'news' => true,
'company' => true,
'employee' => true,
'responseInstructions' => true,
'image' => '<string>',
'lists' => true,
'browserTask' => [
],
'researchTask' => true,
'documentCreation' => true,
'sleepTool' => true,
'canvasTool' => true,
'mcpServers' => [
'<string>'
],
'composioTools' => [
'<string>'
],
'toolRouter' => true,
'audienceTools' => true,
'voiceId' => '<string>'
],
'templateId' => '<string>',
'templateVersion' => 123
]),
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.parallellabs.app/api/v0/scheduled-tasks"
payload := strings.NewReader("{\n \"employeeId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"companyId\": \"<string>\",\n \"scheduledAt\": \"<string>\",\n \"recurringConfig\": {\n \"time\": \"<string>\",\n \"daysOfWeek\": [\n 123\n ],\n \"dayOfMonth\": 123,\n \"activeHoursStart\": \"<string>\",\n \"activeHoursEnd\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"contextSettings\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"shortTermMemories\": true,\n \"longTermMemories\": true,\n \"documents\": true,\n \"documentStrategy\": \"<string>\",\n \"documentPath\": \"<string>\",\n \"requestDocuments\": [\n {}\n ],\n \"searchEngine\": true,\n \"websites\": true,\n \"websitesJs\": true,\n \"news\": true,\n \"company\": true,\n \"employee\": true,\n \"responseInstructions\": true,\n \"image\": \"<string>\",\n \"lists\": true,\n \"browserTask\": {},\n \"researchTask\": true,\n \"documentCreation\": true,\n \"sleepTool\": true,\n \"canvasTool\": true,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"composioTools\": [\n \"<string>\"\n ],\n \"toolRouter\": true,\n \"audienceTools\": true,\n \"voiceId\": \"<string>\"\n },\n \"templateId\": \"<string>\",\n \"templateVersion\": 123\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.parallellabs.app/api/v0/scheduled-tasks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employeeId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"companyId\": \"<string>\",\n \"scheduledAt\": \"<string>\",\n \"recurringConfig\": {\n \"time\": \"<string>\",\n \"daysOfWeek\": [\n 123\n ],\n \"dayOfMonth\": 123,\n \"activeHoursStart\": \"<string>\",\n \"activeHoursEnd\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"contextSettings\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"shortTermMemories\": true,\n \"longTermMemories\": true,\n \"documents\": true,\n \"documentStrategy\": \"<string>\",\n \"documentPath\": \"<string>\",\n \"requestDocuments\": [\n {}\n ],\n \"searchEngine\": true,\n \"websites\": true,\n \"websitesJs\": true,\n \"news\": true,\n \"company\": true,\n \"employee\": true,\n \"responseInstructions\": true,\n \"image\": \"<string>\",\n \"lists\": true,\n \"browserTask\": {},\n \"researchTask\": true,\n \"documentCreation\": true,\n \"sleepTool\": true,\n \"canvasTool\": true,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"composioTools\": [\n \"<string>\"\n ],\n \"toolRouter\": true,\n \"audienceTools\": true,\n \"voiceId\": \"<string>\"\n },\n \"templateId\": \"<string>\",\n \"templateVersion\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/scheduled-tasks")
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 \"employeeId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"companyId\": \"<string>\",\n \"scheduledAt\": \"<string>\",\n \"recurringConfig\": {\n \"time\": \"<string>\",\n \"daysOfWeek\": [\n 123\n ],\n \"dayOfMonth\": 123,\n \"activeHoursStart\": \"<string>\",\n \"activeHoursEnd\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"contextSettings\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"shortTermMemories\": true,\n \"longTermMemories\": true,\n \"documents\": true,\n \"documentStrategy\": \"<string>\",\n \"documentPath\": \"<string>\",\n \"requestDocuments\": [\n {}\n ],\n \"searchEngine\": true,\n \"websites\": true,\n \"websitesJs\": true,\n \"news\": true,\n \"company\": true,\n \"employee\": true,\n \"responseInstructions\": true,\n \"image\": \"<string>\",\n \"lists\": true,\n \"browserTask\": {},\n \"researchTask\": true,\n \"documentCreation\": true,\n \"sleepTool\": true,\n \"canvasTool\": true,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"composioTools\": [\n \"<string>\"\n ],\n \"toolRouter\": true,\n \"audienceTools\": true,\n \"voiceId\": \"<string>\"\n },\n \"templateId\": \"<string>\",\n \"templateVersion\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"companyId": "<string>",
"userId": "<string>",
"employeeId": "<string>",
"name": "<string>",
"prompt": "<string>",
"scheduleType": "<string>",
"scheduledAt": "<string>",
"recurringConfig": {},
"contextSettings": {},
"timezone": "<string>",
"nextRunAt": "<string>",
"lastRunAt": "<string>",
"status": "<string>",
"runCount": 123,
"templateId": "<string>",
"templateVersion": 123,
"createdDate": "<string>",
"updatedDate": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
CompanyApiKeyBearerAuth & CompanyId
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Body
application/json
Scheduled task to create
Request body for creating a scheduled task
ID of the AI employee that runs the task
Short descriptive name
The instruction the employee executes on every run. Be specific.
Company ID. Optional when the API key is a company key.
one_time (default), recurring, or heartbeat
Available options:
one_time, recurring, heartbeat One-time tasks: ISO 8601 datetime to run at
Schedule details for recurring and heartbeat tasks
Show child attributes
Show child attributes
IANA timezone the schedule is expressed in (default: UTC)
Tool and context settings for the run. Defaults to the employee's own chat settings when omitted.
Show child attributes
Show child attributes
Template this task was created from, if any
Version of that template
Response
The created task
Scheduled task
User who owns the task
one_time, recurring, or heartbeat
One-time tasks: ISO 8601 run time
Recurring or heartbeat schedule details
Tool and context settings for runs
ISO 8601 time of the next run, null when none
ISO 8601 time of the last run, null when never run
active, paused, or completed