Schedules

Creates a schedule that fires a launch run on a cron. The launch config is either copied from an existing launch run (fromLaunchRunId) or given inline (skill, repo, …); provide exactly one.

post/experimental/schedules

Headers

Authorizationstring

Request body

workspaceNamestring required
cronstring required

Cron expression the schedule fires on, interpreted in timezone. Rejected if unparseable or if its tightest interval is under the minimum allowed.

timezonestring

IANA timezone the cron is interpreted in (e.g. America/New_York). Defaults to UTC.

fromLaunchRunIdstring uuid

Id of an existing launch run whose stored config this schedule copies. Mutually exclusive with the inline launch spec; provide exactly one. The caller must be able to view the launch run's workspace.

labelstring
descriptionstring
metadataobject
projectIdstring uuid

Project to attach the schedule to. Must be an active, editable project in the target org. When omitted, the project is inferred from the repository URL, and only when exactly one project in the workspace uses that repository.

skillstring

The plugin to install and the skill to run. A value without a file: prefix means a registry ref (either a full workspace/plugin[@version] or a bare plugin[@version] name resolved across the workspaces the caller can see); a value with a file: prefix means a local plugin path inside the cloned repo (e.g. file:apps/cli/plugins/agent-enablement). Either form may carry a trailing #skill selector (e.g. workspace/plugin@1.0.0#implement-ticket or file:apps/cli/plugins/agent-enablement#implement-ticket) that installs the whole plugin and launches the one named skill; it is required when the plugin exposes more than one skill. This is a wire convention: the value is stored verbatim and interpreted downstream by the launch recipe.

repostring
baseBranchstring
sandboxSnapshotstring

Operational override selecting the sandbox runtime image the launch run is created from. When omitted the run falls back to the configured default.

workdirstring
agentstring
modelstring
inputsobject

Skill-specific inputs forwarded to the launched skill, keyed by the skill's own placeholder names (e.g. ISSUE_IDENTIFIER, ISSUE_TITLE, ISSUE_DESCRIPTION).

instructionsstring

Free-text instructions appended to the skill prompt the launch agent runs, mirroring the local --instructions flag. Distinct from the structured inputs channel.

environmentIdstring uuid

Id of a workspace environment whose sealed .env payload is opened server-side at each run. Must belong to the schedule workspace. Resolved live when each run fires, so environment edits take effect on subsequent runs and a deleted environment fails the launch.

timeoutMsinteger

Per-run override, in milliseconds, for how long each fired run may work before it is timed out. Extends the default 50-minute timeout (3000000) up to 6 hours (21600000). Must be a whole number of minutes (a multiple of 60000). Omitted keeps the default.

Response

Default Response

Changes

Changed in 6 of the 55 revisions of this API.17

  • b777eddaa91311See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      the request property's max was increased from 14400000.00 to 21600000.00

      request-property-max-increased

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      endpoint added

      endpoint-added