Skip to main content
The Pulsewave API is a REST API. It accepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes and verbs.

Base URL

https://api.pulsewave.dev/v1

Sandbox URL

https://api.sandbox.pulsewave.dev/v1

Resources

Specification

This reference is generated from our OpenAPI document.

OpenAPI specification

View the raw openapi.json

Authentication

Every request must include an API key in the Authorization header:
See Authentication for the difference between live and test keys, and how to scope keys to specific permissions.

Idempotency

POST requests that create a resource accept an Idempotency-Key header so they can be safely retried. See Idempotency.

Errors

Errors share a consistent shape across every endpoint. See Errors for the full list of error types and codes.