Skip to main content
GET
/
v1
/
agents
/
{agent_id}
/
self-schedules
/
settings
Get Self-Schedule Settings
curl --request GET \
  --url https://api.xpander.ai/v1/agents/{agent_id}/self-schedules/settings \
  --header 'x-api-key: <api-key>'
{
  "can_self_schedule": true,
  "max_self_schedules": 500
}
Returns the agent’s self-scheduling capability. An agent can only book its own future runs when can_self_schedule is enabled.

​
Response

​
can_self_schedule
boolean
Whether the agent may schedule its own future runs.
​
max_self_schedules
integer | null
Per-task lifetime cap on chained self-schedules (1–1000).

​
Example Request

curl -X GET -H "x-api-key: <your-api-key>" \
  "https://api.xpander.ai/v1/agents/<agent-id>/self-schedules/settings"

​
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

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