Learn what you can do with the API and what concepts you should understand before you start.
The API Reference documents every endpoint you can call directly against the platform's backend services. Each page includes the request method, path, parameters, and response schema for one operation.
Before you start, you should understand web programming concepts and JSON data formats. The API is HTTP-based and follows REST conventions.
Authentication
Requests are authorized with an encrypted API key associated with your user account. See Authentication for how to obtain and use it.
Base URL
There is no single base URL for the entire API -- the platform is built on independent backend services, and each endpoint's Reference page shows its own Base URL at the top (for example, https://elastic.messangi.me/oberyn for messaging, or https://msgi.me for the URL Shortener). Always use the base URL shown on the specific endpoint you're calling, not a URL from another endpoint.
Versioning
Endpoints are versioned individually via their path (/v1/, /v2/, /v3/, or /i1/) rather than through a single global API version. The version is part of each endpoint's documented path -- use the exact path shown on that endpoint's page.
Rate limits
Rate limits are specific to each channel and endpoint rather than a single global limit. See Message throughput and rate limits for details.
Response format and errors
Every response follows a common envelope -- see Base Response -- and uses standard Status Codes to indicate success or failure.
Document conventions
See Document conventions for how endpoint paths and JSON property tables are formatted throughout this section.
Key terms
Unfamiliar terms (contact, broadcast, workspace, etc.) are defined in the Glossary.