LoomCycle Schedule
AI-generatedSummary
Create, fork, retrieve, list, or retire LoomCycle schedule definitions. Use it to configure recurring agent runs, including cron timing, agent, prompt, credentials, metadata, and per-run user settings.
Inputs
- Operation (required) — Choose the schedule definition action: create, fork, get, list, or retire.
- Name — Schedule name used for get, list, create, or retire; create refuses names that collide with a static schedule.
- Def ID — For retire, optionally identify a specific definition version; leave empty to retire the active version for the name.
- Parent Def ID — For fork, the template definition to copy. Fields not supplied in the overlay are inherited.
- Cron Expression — For create, the schedule's cron expression. The server validates it and refuses invalid expressions.
- Agent Name or ID — For create, the agent spawned on each scheduled fire. The agent choices are loaded from LoomCycle's agent library; expressions are supported.
- Prompt — For create, the prompt sent to the agent on each fire. It is wrapped as trusted text unless Treat Prompt as Untrusted is enabled.
- Description — Optional operator-visible description for a created or forked version.
- Per-Fire Credentials — Named template-string values injected into each run as user credentials. Forking a template with required credentials requires supplying every required key; plaintext credentials are not accepted on this path.
- Metadata (JSON) — Optional structured, non-secret metadata passed to the agent on each fire. Code-JS agents read it as input.metadata; LLM agents receive it as a trusted prompt block.
- Overlay (JSON) — For fork, a JSON diff applied to the parent definition. Per-Fire Credentials are merged into user_credentials and Metadata into metadata.
- Additional Fields — For create, optional settings include catch-up limit, enabled state, required credential keys, timezone, prompt trust handling, user ID, and user tier.
- Promote to Active — For create or fork, controls whether the new version becomes active immediately; defaults to true.
Output shape
A single record or a list of records, depending on the selected operation.
The operation returns the schedule definition tool response. Create and fork can return the newly authored version; get and list retrieve definitions; retire reports the retirement result. Exact fields vary by operation. Errors include invalid cron expressions and substrate refusals such as static-name collisions or missing required fork credentials.