Cancel an unconfirmed, pending, or dispatched schedule

Returns the updated schedule (200, not 204). A schedule that already fired is a 404 because there is nothing left to cancel.

delete/v1/agents/{agentID}/schedules/{scheduleID}

Request

  • Base URL: https://api.plori.ai
  • URL: https://api.plori.ai/v1/agents/{agentID}/schedules/{scheduleID}
  • Auth: HTTP bearer

Path parameters

agentIDstring uuid required
scheduleIDstring uuid required

Response

Cancelled.

idstring uuid
agent_idstring uuid
kind'once'
status'awaiting_confirmation' | 'pending' | 'firing' | 'dispatched' | 'done' | 'cancelled' | 'failed'

AI-client-created schedules await owner confirmation. done does not establish task success; inspect the run outcome.

promptstring
fire_atstring date-time
thread_idstring
metadataobject
last_errorstring
attemptsinteger
created_atstring date-time
last_fired_atstring date-time
confirmed_atstring date-time

Time the owner confirmed the schedule. Absent when unset.

confirm_urlstring uri

Owner confirmation page. Present only for awaiting_confirmation schedules.

Changes

No recorded changes to this operation across all 1 revision of this API.