world.ptah.cadence Documentation (EN)

main record

Temporal orchestration for content delivery. Controls when and how works surface — release schedules, gated access, sequential unlocks, ritualized drops. The world's clock.

Record Key tid Timestamp-based ID

Properties

audienceTier string Optional

Who gets access under this cadence. public = everyone. supporters = paid/supporting audience. early = early access window before public. private = specific audience only.

Known values: public, supporters, early, private

cadenceRule string Optional

RRULE string (RFC 5545) or human-readable schedule description defining the temporal pattern

maxLength: 2560 bytesmaxGraphemes: 256 graphemes

cadenceType string Optional

The temporal orchestration mode. scheduled = fixed dates/times. sequential = ordered progression, next unlocks after previous. gated = conditional access based on criteria. ritualized = irregular, unpredictable drops designed to break habituation.

Known values: scheduled, sequential, gated, ritualized

canonicalStatus string Optional

The canonical standing of this cadence

Known values: world.ptah.defs#canonicalStatusOfficial, world.ptah.defs#canonicalStatusCommunity, world.ptah.defs#canonicalStatusApocryphal

channelHints array of string Optional

Preferred delivery surfaces for this cadence. Presence in array = preferred. Extensible — new surfaces can be added without schema changes.

Known values: calendar, wallet, notification, feed

createdAt string datetime Required

Timestamp when this cadence record was created

creatorDID string did Required

The permanent identity of the cadence record's creator

description string Optional

What this cadence is about

maxLength: 10240 bytesmaxGraphemes: 1024 graphemes

endsAt string datetime Optional

When this cadence ends (absent = ongoing)

name string Required

The name of this cadence

maxLength: 640 bytesmaxGraphemes: 64 graphemes

startsAt string datetime Optional

When this cadence begins

status string Optional

Current state of this cadence

Known values: draft, active, paused, completed, cancelled

targetReferences array of string at-uri Required

References to the works this cadence orchestrates

unlockCondition string Optional

Human-readable description of what triggers the next release or access change

maxLength: 2560 bytesmaxGraphemes: 256 graphemes

worldReference string at-uri Required

Reference to the world this cadence belongs to

View raw schema

{
  "description": "Temporal orchestration for content delivery. Controls when and how works surface — release schedules, gated access, sequential unlocks, ritualized drops. The world's clock.",
  "key": "tid",
  "record": {
    "properties": {
      "audienceTier": {
        "description": "Who gets access under this cadence. public = everyone. supporters = paid/supporting audience. early = early access window before public. private = specific audience only.",
        "knownValues": [
          "public",
          "supporters",
          "early",
          "private"
        ],
        "type": "string"
      },
      "cadenceRule": {
        "description": "RRULE string (RFC 5545) or human-readable schedule description defining the temporal pattern",
        "maxGraphemes": 256,
        "maxLength": 2560,
        "type": "string"
      },
      "cadenceType": {
        "description": "The temporal orchestration mode. scheduled = fixed dates/times. sequential = ordered progression, next unlocks after previous. gated = conditional access based on criteria. ritualized = irregular, unpredictable drops designed to break habituation.",
        "knownValues": [
          "scheduled",
          "sequential",
          "gated",
          "ritualized"
        ],
        "type": "string"
      },
      "canonicalStatus": {
        "description": "The canonical standing of this cadence",
        "knownValues": [
          "world.ptah.defs#canonicalStatusOfficial",
          "world.ptah.defs#canonicalStatusCommunity",
          "world.ptah.defs#canonicalStatusApocryphal"
        ],
        "type": "string"
      },
      "channelHints": {
        "description": "Preferred delivery surfaces for this cadence. Presence in array = preferred. Extensible — new surfaces can be added without schema changes.",
        "items": {
          "type": "string"
        },
        "knownValues": [
          "calendar",
          "wallet",
          "notification",
          "feed"
        ],
        "type": "array"
      },
      "createdAt": {
        "description": "Timestamp when this cadence record was created",
        "format": "datetime",
        "type": "string"
      },
      "creatorDID": {
        "description": "The permanent identity of the cadence record's creator",
        "format": "did",
        "type": "string"
      },
      "description": {
        "description": "What this cadence is about",
        "maxGraphemes": 1024,
        "maxLength": 10240,
        "type": "string"
      },
      "endsAt": {
        "description": "When this cadence ends (absent = ongoing)",
        "format": "datetime",
        "type": "string"
      },
      "name": {
        "description": "The name of this cadence",
        "maxGraphemes": 64,
        "maxLength": 640,
        "type": "string"
      },
      "startsAt": {
        "description": "When this cadence begins",
        "format": "datetime",
        "type": "string"
      },
      "status": {
        "description": "Current state of this cadence",
        "knownValues": [
          "draft",
          "active",
          "paused",
          "completed",
          "cancelled"
        ],
        "type": "string"
      },
      "targetReferences": {
        "description": "References to the works this cadence orchestrates",
        "items": {
          "format": "at-uri",
          "type": "string"
        },
        "type": "array"
      },
      "unlockCondition": {
        "description": "Human-readable description of what triggers the next release or access change",
        "maxGraphemes": 256,
        "maxLength": 2560,
        "type": "string"
      },
      "worldReference": {
        "description": "Reference to the world this cadence belongs to",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "name",
      "creatorDID",
      "worldReference",
      "createdAt",
      "targetReferences"
    ],
    "type": "object"
  },
  "type": "record"
}