Skip to main content
API reference sections

Schema

ScheduleDefinition

One coherent definition edit. The document boundary rejects revision 0 and any edit that does not advance exactly once.

Type object

Shape

FieldTypeDescription
revisionrequiredinteger (uint32, >= 0)
effective_at_msrequiredinteger (int64)

The inclusive lower bound for occurrences under this revision. Edits and resumes advance it, so a new rule cannot catch up older slots.

templaterequiredDelegationTemplate

The reusable request fields. RunId, executing device, and document version pins exist only for one claimed firing and cannot be stored here.

recurrencerequiredRecurrenceRule

A persisted recurrence rule. The variants preserve Koru's existing floating-versus-zoned distinction without an optional timezone.

lifecyclerequiredScheduleLifecycle
Example
{
  "revision": 0,
  "effective_at_ms": 0,
  "template": {
    "requested_by": {
      "profile": "00000000-0000-4000-8000-000000000000",
      "kind": "person"
    },
    "objective": "string",
    "agent": {
      "kind": "built_in",
      "value": "string"
    },
    "requested_model": "string",
    "scope": {
      "kind": "none"
    },
    "grants": [],
    "context": []
  },
  "recurrence": {
    "cron": "string",
    "type": "floating"
  },
  "lifecycle": "active"
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.