Dedicated gateway surface

One API front door for Aevaro products.

Use stable product prefixes on api.aevaro.com while Aevaro keeps product origins, runtime ownership, and cutover details behind a controlled gateway boundary.

Playground

Build a request from the live prefix catalog

The request builder, catalog cards, gateway rewrites, smoke matrix, and JSON endpoint all read from the same manifest.

Product

Endpoint

Authpublic
Prefix/core
Statusavailable
curl -X GET https://api.aevaro.com/core/health \
  -H "x-request-id: partner-smoke-001"

Gateway response contract

Responses preserve origin status and include request correlation headers. Reserved or unknown prefixes fail closed before reaching a product origin.

SDK starting point

Keep generated clients thin until the external product contracts are stable. The first durable contract is host, prefix, auth mode, and request ID propagation.

const response = await fetch("https://api.aevaro.com/core/health", {
  headers: {
    Authorization: `Bearer ${process.env.AEVARO_API_TOKEN}`,
    "x-request-id": crypto.randomUUID(),
  },
});

if (!response.ok) {
  throw new Error(`Aevaro API returned ${response.status}`);
}

const payload = await response.json();
curl https://api.aevaro.com/connect/health \
  -H "Authorization: Bearer $AEVARO_API_TOKEN" \
  -H "x-request-id: partner-smoke-001"

Reserved prefix checker

Only documented product prefixes are public contracts. Other prefixes fail closed without exposing internal routing details.

GET /core/health
GET /connect/health
GET /learning/health

Catalog

Product API surfaces

The rendered cards and the JSON catalog come from the same typed manifest, so the page stays aligned with gateway routing and smoke coverage.

JSON catalog

Core

available

Performance operating data, goals, marketplace, document intake, and Core product APIs.

  • GET/core/health
  • POST/core/trpc/:procedure

Connect

available

CRM, communications, sequences, phone, and sales-workflow endpoints for the Connect product.

  • GET/connect/health
  • POST/connect/trpc/:procedure

Learning

available

Learning paths, skill evidence, manager workflows, and education product APIs.

  • GET/learning/health
  • GET/learning/courses

Flow

preview

Agent workflow runtime, execution ledgers, approvals, and future external automation surfaces.

  • GET/flow/v1/health

People

preview

People product API for assessments, profiles, and organizational talent signals.

  • GET/people/health
  • GET/people/v1/profiles

Integration posture

How external API access will stay manageable

1

Choose a product prefix

External callers use one stable Aevaro API host and a product prefix, for example /connect or /core. Product origins stay replaceable behind the facade.

2

Use user or partner credentials

External calls use approved user or partner credentials. First-party Auth and Platform control-plane surfaces stay off the public gateway by default.

3

Carry request identity

The gateway preserves or generates x-request-id and stamps x-aevaro-gateway-version so support and product logs can be joined.

4

Keep callbacks origin-stable

Vendor webhooks and OAuth finalizers remain on product origins until an explicit callback migration decision lands.

Prefix posture

Only documented product prefixes are public contracts. Other prefixes return 404 without exposing internal ownership or routing rationale.

curl https://api.aevaro.com/core/health
curl https://api.aevaro.com/connect/health
curl https://api.aevaro.com/people/health

Operations

Update contract

To update the API frontend, edit the catalog, not the page. The gateway rewrite table, docs, and tests are intentionally wired around the same product prefix data.

Prefixes

Product prefixes are stable customer-facing contracts. Origin moves should only change env vars and rewrite mappings.

Credentials

Public gateway calls carry user or partner credentials. Internal service-role credentials stay off the facade.

Callbacks

Vendor callback migration is a separate decision because callback URLs are operational contracts with external systems.