Planable · OpenAPI Overlay 1.0.0

API Evangelist enhancements — Planable System API

2 actions 2 updates documentation extends openapi/planable-system-api-openapi.yml
Derived by API Evangelist Built from the contracts Planable publishes. Planable did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdx-rate-limitsx-error-catalogx-conventionsx-idempotencyx-plan-gatex-docs

Targets 2

$.paths['/ping'].get
$.info

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements — Planable System API
  version: 1.0.0
extends: openapi/planable-system-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: openapi/_original/planable-openapi.json
x-note: Non-destructive enhancement of Planable's published contract. Planable declares no operationId on any of
  its 51 operations, which forces every generator and MCP tool-forge to synthesize names. This overlay assigns deterministic
  verb+path operationIds and documents the runtime semantics Planable states in prose but does not encode in the
  spec. The operationIds are API EVANGELIST's, not Planable's — do not cite them as published. The original spec
  is never mutated.
actions:
- target: $.paths['/ping'].get
  description: Assign a stable operationId for GET /ping — the published spec declares none.
  update:
    operationId: getPing
- target: $.info
  description: Record the runtime semantics Planable publishes in its developer guide but omits from the spec.
  update:
    x-rate-limits:
      read: 600 requests/minute per token
      write: 120 requests/minute per token
      algorithm: Redis-backed sliding window
      headers:
      - X-RateLimit-Limit
      - X-RateLimit-Remaining
      - X-RateLimit-Reset
      retry_after: false
      source: https://planable.io/guides/planable-public-api/
    x-error-catalog: errors/planable-problem-types.yml
    x-conventions: conventions/planable-conventions.yml
    x-idempotency:
      header: null
      mechanism: natural-key semantic idempotency on 4 operations
      detail: conventions/planable-conventions.yml
    x-plan-gate: API token generation requires a Pro or Enterprise plan
    x-docs: https://api.planable.io/api/v1/docs

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/planable-system-api-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.