{% api %}

Valid Children

Tag	Multiplicity
{% action %}	[*]
{% event %}	[*]
{% operation %}	[*]
{% error %}	[*]

Valid Parent Contexts

This tag is valid inside: {% domain %}, {% feature %}

Rules

Rule	Force	Realm	Reference	Description
api-names-kebab-case	must	global	—	Action and event names use plain kebab-case — no type prefix. The tag type provides the context. conventionnaming
feature-api-references-domain	should	global	—	Feature actions should reference domain actions by name in their description. convention
api-scope-inherited	must	global	—	Scope is inherited from the parent domain or feature tag. scope

The api tag acts as a container for all machine-callable actions and system-emitted events. It ensures that the technical interface of a domain or feature is clearly defined for both humans and AI agents.

API container with action and event children

tagapiactionevent api-tag-container

{% api %}
  {% action name="submit-credentials" %}
  Accepts email and password. Returns session token on success.
  {% /action %}

  {% event name="user-authenticated" %}
  Payload: { userId: string, sessionToken: string }.
  {% /event %}
{% /api %}