API Reference

Base URL: https://api.buildpathio.com/v1 — all requests require a Bearer token in the Authorization header.

Authentication

API tokens are scoped to a workspace. Find your token under Settings → API Tokens in the dashboard.

Authorization: Bearer bpth_live_xxxxxxxxxxxxxxxxxxxxxxxx

Manifests

Submit a service manifest. Call this from CI on every commit that touches the service's contracts or dependency list. Idempotent by service + version.

Request body

{
  "service": "order-service",       // string, required
  "version": "1.4.2",              // semver string, required
  "team": "fulfillment",           // string, optional
  "contracts": [...],              // array of ContractObject
  "dependencies": [...]            // array of DependencyObject
}

Retrieve the latest manifest for a named service.

Remove a service manifest from the graph. Use when decommissioning a service. Downstream dependents will receive a WARNING on their next check until they remove the dependency from their own manifests.

Graph queries

Returns the full dependency graph for the workspace as a JSON object with nodes[] and edges[]. Suitable for visualization or auditing.

Returns all services downstream of {service}, their ownership, and the nature of the dependency (HTTP contract / gRPC / event). This is what the CI check calls before annotating a PR.

Impact analysis

Run a point-in-time impact check for a proposed manifest change. Useful for previewing risk before pushing. Returns breaking[], warning[], and unaffected[] downstream services.