Schedules

Create a new schedule

Changed on
post/api/schedules

Request

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

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 required
descriptionstring
cronExpressionstring
intervalMsinteger
taskTemplatestring
taskTypestring
tagsstring[]
priorityinteger
targetAgentIdstring
enabledboolean
timezonestring
modelstring
modelTier'smol' | 'regular' | 'smart' | 'ultra'
allowCustomModelboolean
scheduleType'recurring' | 'one_time'
targetType'agent-task' | 'workflow' | 'script'
workflowIdstring uuid
scriptNamestring
scriptArgsobject
paramsobject
requiredParamsstring[]
requiresstring[]
delayMsinteger
runAtstring

Response

Schedule created

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

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status