API reference

The MessagePipe platform exposes four HTTP surfaces. Every one is documented by an OpenAPI 3.1 specification that you can browse interactively, point your codegen at, or paste into Postman / Bruno / Insomnia.

Live, interactive references

Conventions

• Base URL: https://api.dev.messagepipe.dev.
• Versioning: public endpoints live under /v1. Backwards-incompatible changes ship as /v2; we never repurpose a path.
• Content type: application/json requests and responses. UTF-8.
• Field names: send requests match field names exactly, as documented (reply_to, template_version, scheduled_for). A case variant such as To, Subject or Data is refused with 400 validation_failed (details.constraint key:case) on every channel, rather than read as the field. The official SDKs already send the exact names. Keys inside data, headers and metadata are yours and keep whatever case you give them.
• Errors: see Errors.
• Rate limits: see Rate limits.
• Request id: every response carries X-Request-Id. Quote it in support tickets.

Spec downloads

Need the raw YAML for codegen?

• send-api.yaml
• mgmt-api.yaml
• delivery-event.yaml
• analytics.yaml