Skip to main content

API Surface Map

Use this page when you need a fast map of the most important Helpifyr route families before dropping into exact product API reference pages.

When to use this page​

  • You know you need an API route but not yet which family.
  • You need a public-safe guide to the available control-plane surfaces.
  • You want to map a question to the right reference page or verification path.

Prerequisites​

Architecture / Flow​

flowchart TD
    A["Question or workflow"] --> B["Choose route family"]
    B --> C["Read exact reference or product page"]
    C --> D["Run bounded verification route"]

Route families​

Docs platform and publication​

GET /api/v1/docs/platform
GET /api/v1/docs/catalog
GET /api/v1/docs/readiness

Use these when the question is about docs publication, catalog visibility, or reviewed artifact posture.

Contracts and projections​

GET /api/v1/contracts/registry
GET /api/v1/contracts/drift
GET /api/v1/platform/projection-catalog
GET /api/v1/platform/version-truth

Use these when the question is about source truth, drift, or current projection state.

Runtime and readiness​

GET /health
GET /api/v1/platform/services
GET /api/v1/observability/readiness
GET /api/v1/security/readiness
GET /api/v1/recovery/readiness
GET /api/v1/signoff/readiness

Use these when the question is about live posture, operator readiness, or escalation decisions.

Event and workflow modeling​

GET /api/v1/event-modeling/catalog
GET /api/v1/event-modeling/dependency-graph
GET /api/v1/agent/contracts
GET /api/v1/agent/workflow

Use these when the question is about event families, dependencies, or agent/workflow truth.

Verification​

This map is being used correctly when:

  1. the route family matches the real question
  2. the next read is an exact reference page or live endpoint, not a guess
  3. the reader can explain why this family is preferred over another one

Common failure modes​

Searching blindly across every route​

Problem:

  • the reader loses the model of how the API is organized.

Better path:

  • choose the family first, then read the exact reference

Using summary routes when contract truth is needed​

Problem:

  • the result is too shallow for verification.

Better path:

  • switch from summary or health routes to contracts or projections

Source Truth​

Next paths​