API reference
Every operation of the Postgale REST API with its parameters, request and response schemas, and a playground.
This reference is generated from the OpenAPI 3.1 document the API itself serves, so it lists exactly the
operations, parameters and schemas of this instance. Paths are relative to https://postgale.com/api/v1.
- Pick an operation in the sidebar (grouped by tag) or search for it with ⌘ K.
- Each page shows the parameters, the request body and the responses with their schemas, and example requests.
- Try it sends the request from your browser to this instance with the
Authorization: Bearer sk_…key you enter. Requests are live: creating or publishing a post, sending a message or boosting a post acts on the real accounts of the key's organization.
For the concepts behind the operations (approval, idempotency, the messaging window, webhook signatures) read the REST API guide, and for errors the error codes.