API surfaces

Not every operation is served from the same host. The public API and the dashboard share the code but expose different sets, and an operation outside a host's set answers 404 there even with valid credentials.

surfaceoperationswho consumes it
Public API129Integrations using an API key
Dashboard607The web application, with a browser session

The 129 public-API operations also answer in the dashboard; the remaining 478 are dashboard-only: 409 belong to the administration plane and the rest to the session and the account.

Telling which one an operation belongs to

Each reference page declares it. Two indicators settle it:

  • Visibility — public or admin. The admin ones do not appear in the public reference.
  • Authentication method — an operation accepting only a browser session is not meant to be integrated from code, even though it exists.

Diagnosing an unexpected 404

A 404 on a route the documentation describes usually means the operation does not belong to the surface being called, not that the route is missing. It is the costliest confusion when integrating, because the status code suggests a routing mistake when the problem is the host.

Before reviewing the route, check the surface declared on its reference page. If the operation is dashboard-only, no credential will make it answer on the API host.

Version

Every route hangs off /v1. The route family that served the request travels in meta.api_version on each response, as described in the response shape.