Skip to main content
POST
/
v1
/
bot
/
heartbeat
/
configure
Configure Heartbeat
curl --request POST \
  --url https://api.boostgpt.co/v1/bot/heartbeat/configure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "bot_id": "<string>",
  "prompt": "<string>",
  "cron_pattern": "<string>",
  "enabled": false,
  "timezone": "UTC",
  "credit_budget": 123,
  "max_consecutive_errors": 5,
  "member_id": "<string>"
}
'
import requests

url = "https://api.boostgpt.co/v1/bot/heartbeat/configure"

payload = {
"project_id": "<string>",
"bot_id": "<string>",
"prompt": "<string>",
"cron_pattern": "<string>",
"enabled": False,
"timezone": "UTC",
"credit_budget": 123,
"max_consecutive_errors": 5,
"member_id": "<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({
project_id: '<string>',
bot_id: '<string>',
prompt: '<string>',
cron_pattern: '<string>',
enabled: false,
timezone: 'UTC',
credit_budget: 123,
max_consecutive_errors: 5,
member_id: '<string>'
})
};

fetch('https://api.boostgpt.co/v1/bot/heartbeat/configure', 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/heartbeat/configure",
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>',
'prompt' => '<string>',
'cron_pattern' => '<string>',
'enabled' => false,
'timezone' => 'UTC',
'credit_budget' => 123,
'max_consecutive_errors' => 5,
'member_id' => '<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://api.boostgpt.co/v1/bot/heartbeat/configure"

payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"prompt\": \"<string>\",\n \"cron_pattern\": \"<string>\",\n \"enabled\": false,\n \"timezone\": \"UTC\",\n \"credit_budget\": 123,\n \"max_consecutive_errors\": 5,\n \"member_id\": \"<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://api.boostgpt.co/v1/bot/heartbeat/configure")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"prompt\": \"<string>\",\n \"cron_pattern\": \"<string>\",\n \"enabled\": false,\n \"timezone\": \"UTC\",\n \"credit_budget\": 123,\n \"max_consecutive_errors\": 5,\n \"member_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.boostgpt.co/v1/bot/heartbeat/configure")

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 \"prompt\": \"<string>\",\n \"cron_pattern\": \"<string>\",\n \"enabled\": false,\n \"timezone\": \"UTC\",\n \"credit_budget\": 123,\n \"max_consecutive_errors\": 5,\n \"member_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "heartbeat": {
    "uuid": "<string>",
    "bot_id": 123,
    "member_id": 123,
    "prompt": "<string>",
    "cron_pattern": "<string>",
    "timezone": "<string>",
    "credit_budget": 123,
    "credits_used": 123,
    "last_executed_at": "<string>",
    "execution_count": 123,
    "error_count": 123,
    "max_consecutive_errors": 123,
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}
{
"error": "<string>",
"code": "<string>"
}
{
"error": "<string>",
"code": "<string>"
}

Authorizations

Authorization
string
header
required

Enter your API key

Body

application/json
project_id
string
required

Project ID

bot_id
string
required

Agent ID

prompt
string
required

Instruction the agent executes each run

cron_pattern
string

Cron expression for scheduling (e.g., '0 9 * * 1' for every Monday at 9am)

enabled
boolean
default:false

Whether the heartbeat is active (default: false)

timezone
string
default:UTC

Timezone for scheduling (default: UTC)

credit_budget
integer | null

Max credits per billing period (null = unlimited)

max_consecutive_errors
integer
default:5

Auto-pause after this many consecutive failures (default: 5)

member_id
string | null

Subscriber member ID for subscriber-specific heartbeats

Response

Heartbeat configured successfully

heartbeat
object