Schedules

Update a schedule

Changed on
put/api/schedules/{id}

Request

  • Base URL
    http://localhost:3013
  • URL
    http://localhost:3013/api/schedules/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

keystring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

namestring
descriptionstring
cronExpressionstring nullable
intervalMsinteger nullable
taskTemplatestring
taskTypestring
tagsstring[]
priorityinteger
targetAgentIdstring nullable
enabledboolean
timezonestring
modelstring nullable
modelTier'smol' | 'regular' | 'smart' | 'ultra' | 'null' nullable
allowCustomModelboolean
nextRunAtstring nullable
targetType'agent-task' | 'workflow' | 'script'
workflowIdstring uuid nullable
scriptNamestring nullable
scriptArgsobject nullable
paramsobject
requiredParamsstring[]
requiresstring[]

Response

Schedule updated

idstring uuid required
keystring required

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

namestring required
descriptionstring
cronExpressionstring
intervalMsinteger
taskTemplatestring
taskTypestring
tagsstring[]
priorityinteger
targetAgentIdstring
enabledboolean
lastRunAtstring date-time
nextRunAtstring date-time
createdByAgentIdstring
parentTaskIdstring
requestedDelayMsinteger
requestedRunAtstring date-time
timezonestring
consecutiveErrorsinteger
lastErrorAtstring date-time
lastErrorMessagestring
modelstring
modelTier'smol' | 'regular' | 'smart' | 'ultra'
scheduleType'recurring' | 'one_time'
targetType'agent-task' | 'workflow' | 'script'
workflowIdstring uuid
scriptNamestring
scriptArgsobject
paramsobject
requiredParamsstring[]
requiresstring[]
createdAtstring date-time required
lastUpdatedAtstring date-time required
createdBystring
updatedBystring
favoriteboolean

Changes