All screens
42 days

API Explorer

Browsable reference of the web app HTTP API surface. 20 routes across 10 groups; 7 return the canonical RPC Error Contract (R2) envelope that feeds straight into the ErrorPanel UI.

Filters

Search and narrow by group or response shape.

Group

Response shape

Routes — 20 of 20

Showing the full API surface.

Events

4 routes
GET
/api/eventsPlain JSON

List all events.

POST
/api/eventsPlain JSON

Create an event (auto-generates code + seeds the default role).

titlestartsAt
POST
/api/events/[id]/transitionError Contract

Transition an event through the 8-state machine via fn_transition_event_state.

targetStateexpectedVersion?
GET
/api/events/[id]/readinessPlain JSON

Weighted readiness score + ceiling for an event.

Nodes

3 routes
GET
/api/events/[id]/nodesPlain JSON

List the nodes (≤5) for an event.

POST
/api/events/[id]/nodesPlain JSON

Add a node to an event.

titleisMandatory?
POST
/api/nodes/[id]/transitionError Contract

Transition a node through its lifecycle via fn_transition_node_state.

targetStateexpectedVersion?

Roles

3 routes
GET
/api/events/[id]/rolesPlain JSON

List roles defined for an event.

POST
/api/events/[id]/rolesError Contract

Define a role on an event (optionally scoped to a node).

titleauthority?required?nodeId?assigneeId?
PATCH
/api/events/[id]/roles/[roleId]Error Contract

Update a single role (assignment / fulfillment).

Invitations

2 routes
GET
/api/invitations/[token]Error Contract

Resolve a single-use invitation token (72h) to its view.

POST
/api/invitations/[token]Error Contract

Accept an invitation — marks fulfillment ASSIGNED.

Instructions

1 route
POST
/api/events/[id]/instructionsError Contract

Publish or supersede a canonical channel instruction.

channelIdcontentsupersede?previousId?expectedVersion?

Nuggets

2 routes
POST
/api/events/[id]/nuggetsPlain JSON

Append an information nugget to an event.

PATCH
/api/events/[id]/nuggetsPlain JSON

Reorder a nugget relative to its neighbour.

Tasks

2 routes
POST
/api/events/[id]/tasksPlain JSON

Create a task for an event.

PATCH
/api/events/[id]/tasksPlain JSON

Update a task (status / assignment).

Alerts

1 route
PATCH
/api/events/[id]/alerts/[alertId]Plain JSON

Update an alert (e.g. acknowledge / resolve).

Acknowledgments

1 route
POST
/api/acksPlain JSON

Record an acknowledgment on the 6-level ladder.

System

1 route
GET
/api/healthPlain JSON

Liveness / health probe.