Base URL & environments

Base URL

The PeakCommerce Agent API is mounted at /api/v1. The tenant a request operates on is determined by your API key (see Authentication), so the same base URL serves every tenant.

Environment	Purpose	Base URL
Production	Live customers and real transactions	https://peakcommerce.app/api/v1
Sandbox	Integration testing, never real money	https://sandbox.peakcommerce.app/api/v1

API keys are environment-specific — a sandbox key cannot call production and vice versa.

OpenAPI specification

The machine-readable spec is published at:

• https://api.peakcommerce.com/api/v1/openapi.json — canonical spec URL

• GET /api/v1/openapi.json on either environment — the same spec

• GET /.well-known/agent-tools.json — the same spec, exposed for AI-agent discovery

These endpoints are unauthenticated and allow cross-origin GET, so documentation tools and AI agents can load them directly.

Versioning

/api/v1 is the first stable, public version. Breaking changes will ship under /api/v2 — not by silently changing v1. Additive, non-breaking changes (new fields, new endpoints, new optional params, new event types) ship continuously into v1.

Content type

Always send Content-Type: application/json on requests with a body. All responses are application/json.

CORS

The spec endpoints above allow cross-origin GET. The data endpoints (/api/v1/*) are designed for server-to-server use; if you need browser access, proxy through your own backend.

Related

• Authentication

• Errors