XPxpander
API v1
Agents
Scheduled Tasks

Create Scheduled Task

Create a recurring scheduled task (cron + prompt). The change takes effect immediately.

post/v1/agents/{agent_id}/scheduled-tasks

Request

  • Base URL
    https://api.xpander.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-api-key

Path parameters

agent_idstring required

Request body

cronstring required

Cron expression (5-field crontab, UTC), e.g. '0 9 * * *'.

promptstring required

Instruction the agent runs on each fire.

titlestring nullable

Optional human-readable label. Auto-generated from the prompt when omitted.

enabledboolean

Create the task active (default) or paused.

type'scheduled-job' | 'live-surface'

What a scheduled task drives — a plain job vs a live-surface regeneration.

llm_model_providerstring nullable

Run this task on a specific LLM provider instead of the agent's own (e.g. 'amazon_bedrock').

llm_model_namestring nullable

Run this task on a specific model id instead of the agent's own; pairs with llm_model_provider.

on_this_laptopboolean

xpander Desktop only: run it on the desktop computer this request comes from whenever the app is open there.

conversation_mode'same' | 'new'

Which conversation a schedule's fires run in.

conversation_idstring nullable

same mode only: the conversation every fire continues, for example the one the caller is in now. Omit to use the schedule's own conversation.

Response

Successful Response

idstring required

Source-node id. Pass it to update/remove/run the task.

titlestring nullable

Human-readable label for the task.

cronstring required

Cron expression (5-field crontab, UTC), e.g. '0 9 * * *'.

promptstring required

Instruction the agent runs on each fire.

enabledboolean

Whether the task is active. Disabled tasks keep their config but do not fire.

type'scheduled-job' | 'live-surface'

What a scheduled task drives — a plain job vs a live-surface regeneration.

managedboolean

Managed by xpander. The platform owns cron/prompt/title; pause or resume it via enabled.

managed_kindstring nullable

Managed flavor - 'heartbeat' schedules derive from Autonomous mode and accept a user prompt addition.

user_promptstring nullable

The user's own addition to a heartbeat prompt; the platform appends its read-only part at run time.

llm_model_providerstring nullable

Run this task on a specific LLM provider instead of the agent's own (e.g. 'amazon_bedrock').

llm_model_namestring nullable

Run this task on a specific model id instead of the agent's own; pairs with llm_model_provider.

conversation_mode'same' | 'new'

Which conversation a schedule's fires run in.

conversation_idstring nullable

The conversation every fire continues, in same mode; empty in new mode.

owner_idstring nullable

Read-only: the member the task runs as.

Changes

No recorded changes to this operation across all 4 revisions of this API.