For the complete documentation index, see llms.txt. This page is also available as Markdown.

SDKs & tooling

PeakCommerce exposes a single, well-documented REST API rather than a fleet of language-specific SDKs. That means you can integrate from any language with an HTTP client today, and generate a typed client for your stack from the OpenAPI specification.

Use the REST API directly

The Agent API is designed to be approachable by hand:

  • Predictable REST over HTTPS, JSON in and out.

  • Action-oriented — every response carries a nextActions array telling you the next legal call, so you can drive a flow without hard-coding URLs.

  • Scoped bearer-token auth — see Authentication and Base URL.

Generate a typed client from OpenAPI

The full API is published as a machine-readable OpenAPI specification. Load it into a generator such as openapi-generator, or into Postman or Redocly, to produce a typed client in your language — and regenerate to stay in sync as the API grows.

Explore and test

  • The interactive API Reference lets you browse every endpoint with its request and response shapes.

  • GET /api/v1/manifest reports your tenant's live capabilities and event types — see Discovery.

  • For event-driven integrations, see the Webhooks overview.

Last updated

Was this helpful?