API v1
Agents
Self Schedules

List Self-Schedules

List the agent's self-scheduled future runs.

get/v1/agents/{agent_id}/self-schedules

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

Query parameters

statusstring nullable

Filter by status: scheduled, completed, or failed.

Response

Successful Response

idstring required

Self-schedule id. Pass it to DELETE to cancel.

agent_idstring required

Owning agent id.

task_idstring nullable

Execution thread the run continues, if any.

promptstring nullable

Instruction for the scheduled run.

run_atstring date-time required

When the run fires (UTC).

statusstring required

scheduled, completed, failed, or cancelled.

cancel_reasonstring nullable

Why the run was cancelled, when status is cancelled.

desktop_device_idstring nullable

Read-only: the desktop computer running xpander Desktop that the run continues on, when it was booked from one.

created_atstring date-time nullable

Creation timestamp.

updated_atstring date-time nullable

Last update timestamp.

Changes

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