Skip to content
GitmoapAPIBeta
Schema

RitualConfig

One ritual of an AI organization. Fields left out take the kind's defaults.

Shape

  • cadenceRitualCadenceWhen it runs.
  • keyRitualKey (string)The key the revision names the ritual by.
  • kindRitualKindstand_upplanningrefinementreviewretrospectivearchitecture_reviewreleasereplenishmentdigestWhat the ritual does.
  • nameRitualName (string)The organization's word for it.
  • scopeRitualScopeWhom it is for.
  • budget_microsinteger · int64 or nulloptional0–∞The most one run may spend, in millionths of a dollar; $5 when absent. A run reaching it ends early and applies nothing it had not finished.
  • facilitatorRitualFacilitator or nulloptionalWho runs it and writes its outcome; the kind's when absent.
  • outputsarray of RitualOutput: one of digest | assignments | cycle_selection | revision_proposal | decision_record | questions or nulloptionalWhat a run may produce, within what the kind allows; all of it when absent.
  • participantsarray of Position: one of engineer | reviewer | product_owner | director | release_manager | technical_writer or nulloptionalThe positions that contribute before the facilitator writes; the kind's when absent.
  • peopleRitualPeopleoptionalWhat people do in it.
  • skip_whenSkipWhennevernothing_changedor nulloptionalWhen a run is skipped without calling a model; the kind's when absent.
  • timeboxRitualTimebox or nulloptionalHow many turns a run's sessions may take; the kind's when absent.
    • The RitualTimebox schema
    • facilitator_turnsinteger · int320–∞Turns the facilitator's session may take.
    • participant_turnsinteger · int320–∞Turns each participant's session may take; 0 means the facilitator writes alone.

Example

Synthesized example
{
"cadence": {
"at": "at-e5cb",
"every": "day",
"days": [
"monday"
]
},
"key": "key-e0ef",
"kind": "stand_up",
"name": "payments-api",
"scope": {
"squad": "squad-562e"
},
"budget_micros": 58,
"facilitator": "squad_lead",
"outputs": [
"digest",
"digest"
],
"participants": [
"engineer",
"engineer"
],
"people": {
"mode": "none"
},
"skip_when": "never",
"timebox": {
"facilitator_turns": 64,
"participant_turns": 80
}
}

Graph

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.