API reference

Summary#

This category is written for developers. It documents the public Metric Vault API, the credential that unlocks it, the complete list of HTTP routes the platform serves, every error the API can return, the limits that apply, and the operator-only endpoints that drive background work. Start with API overview if you have not used the API before, and Make your first API call when you are ready to make a call.

The public API is an Enterprise plan capability. Everything else described here is the internal surface the web app itself calls, documented so that support engineers and developers can reason about what a request did.

Overview#

API basics#

• API overview — what the API offers, the Enterprise gate, base URL and versioning.
• Authentication — creating, using and revoking an mv_live_ key.
• Make your first API call — a working end-to-end call in under five minutes.
• Code examples — curl, JavaScript and Python for every common call.

Endpoints#

• POST /api/v1/analyze — the full reference for POST /api/v1/analyze.
• All endpoints — the complete route table: path, method, authentication and purpose.
• Webhooks — the inbound Stripe webhook and the outbound alert webhooks.
• Internal endpoints — the secret-gated operator routes that run scheduled work.

Errors and limits#

• Error codes — every error code and HTTP status, with cause and fix.
• Rate limits and quotas — hourly rate limits, monthly credit quotas and payload caps.
• Diagnostic endpoints — every /api/diag/* probe and how to call it safely.

Related reading elsewhere in the knowledge base#

• API keys covers key management from the account owner's point of view.
• How credits work explains the credit system that every metered call spends from.
• API key security covers how to handle a key as a production secret.
• The worker (_worker.js) describes the Worker that serves all of this.