Skip to main content
PUT
/
v1
/
agents
/
{agent_id}
/
self-schedules
/
settings
Set Self-Schedule Settings
curl --request PUT \
  --url https://api.xpander.ai/v1/agents/{agent_id}/self-schedules/settings \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "can_self_schedule": true,
  "max_self_schedules": 500
}
'
import requests

url = "https://api.xpander.ai/v1/agents/{agent_id}/self-schedules/settings"

payload = {
"can_self_schedule": True,
"max_self_schedules": 500
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({can_self_schedule: true, max_self_schedules: 500})
};

fetch('https://api.xpander.ai/v1/agents/{agent_id}/self-schedules/settings', 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.xpander.ai/v1/agents/{agent_id}/self-schedules/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'can_self_schedule' => true,
'max_self_schedules' => 500
]),
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.xpander.ai/v1/agents/{agent_id}/self-schedules/settings"

payload := strings.NewReader("{\n \"can_self_schedule\": true,\n \"max_self_schedules\": 500\n}")

req, _ := http.NewRequest("PUT", 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.put("https://api.xpander.ai/v1/agents/{agent_id}/self-schedules/settings")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"can_self_schedule\": true,\n \"max_self_schedules\": 500\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.xpander.ai/v1/agents/{agent_id}/self-schedules/settings")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"can_self_schedule\": true,\n \"max_self_schedules\": 500\n}"

response = http.request(request)
puts response.read_body
{
  "can_self_schedule": true,
  "max_self_schedules": 500
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
Enable or disable whether the agent can schedule its own future runs, and optionally set the per-task cap on chained self-schedules.

Request Body

can_self_schedule
boolean
required
Whether the agent may schedule its own future runs.
max_self_schedules
integer
Per-task lifetime cap on chained self-schedules. Must be between 1 and 1000.

Example Request

curl -X PUT -H "x-api-key: <your-api-key>" -H "Content-Type: application/json" \
  "https://api.xpander.ai/v1/agents/<agent-id>/self-schedules/settings" \
  -d '{ "can_self_schedule": true, "max_self_schedules": 5 }'

Example Response

{
  "can_self_schedule": true,
  "max_self_schedules": 5
}

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

agent_id
string
required

Body

application/json

Agent-level self-schedule capability — request and response for the enable/disable toggle.

can_self_schedule
boolean
required

Whether the agent may schedule its own future runs.

max_self_schedules
integer | null

Per-task lifetime cap on chained self-schedules (1-1000).

Required range: 1 <= x <= 1000

Response

Successful Response

Agent-level self-schedule capability — request and response for the enable/disable toggle.

can_self_schedule
boolean
required

Whether the agent may schedule its own future runs.

max_self_schedules
integer | null

Per-task lifetime cap on chained self-schedules (1-1000).

Required range: 1 <= x <= 1000