Report agent status (heartbeat)

curl --request POST \
  --url http://localhost:3001/api/v1/status/ping \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agentId": "<string>",
  "message": "<string>"
}
'

import requests

url = "http://localhost:3001/api/v1/status/ping"

payload = {
    "agentId": "<string>",
    "message": "<string>"
}
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({agentId: '<string>', message: '<string>'})
};

fetch('http://localhost:3001/api/v1/status/ping', 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 => "3001",
  CURLOPT_URL => "http://localhost:3001/api/v1/status/ping",
  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([
    'agentId' => '<string>',
    'message' => '<string>'
  ]),
  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 := "http://localhost:3001/api/v1/status/ping"

	payload := strings.NewReader("{\n  \"agentId\": \"<string>\",\n  \"message\": \"<string>\"\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("http://localhost:3001/api/v1/status/ping")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agentId\": \"<string>\",\n  \"message\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/v1/status/ping")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agentId\": \"<string>\",\n  \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "clxyz456",
  "name": "My Agent",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "A helpful assistant",
  "avatarUrl": "https://example.com/avatar.png",
  "webhookUrl": "https://example.com/webhook",
  "lastActiveAt": "2025-01-01T12:00:00.000Z"
}

{
  "statusCode": 400,
  "message": "Validation failed",
  "errors": [
    {
      "code": "invalid_type",
      "message": "Expected string, received number",
      "path": [
        "email"
      ]
    }
  ]
}