Public API: endpoints, versions and deprecation

Endpoints

No key is needed and nothing is stored. Answers and errors are JSON; an error looks like {"error": {"code": "...", "message": "...", "hint": "..."}}. The full description is in /openapi.json.

Paging through search results

/api/v1/docs/ answers with up to limit results and a next_cursor. For the next results, send the same request again with cursor set to that value. When there is nothing more, next_cursor is null. A cursor only works with the same q and locale. Treat it as an opaque string.

Versions

• The version is in the path: /api/v1/. v1 is the current and only version.
• Inside v1 we only add things: new fields, new endpoints, new optional parameters. Your code should ignore fields it does not know.
• A change that could break a working client, like removing or renaming a field, changing its type or meaning, or removing an endpoint, only ships under a new path such as /api/v2/.
• This policy covers /api/v1/ and /ask. The MCP server is described on MCP server.

Deprecation policy

• When a new version ships, the old one keeps working for at least 6 months.
• During those months every answer from the old version has a Deprecation header (RFC 9745), a Sunset header (RFC 8594) with the date it stops working, and a Link to the new version.
• The change and its dates are also listed below, under API changes.
• Today nothing is deprecated, so no answer has those two headers. Every answer links here with Link: <https://multiplegroupposter.com/docs/api/>; rel="deprecation".

API changes