Skip to main content

Changes to the HTTP API

Changes to the contract of the Megido HTTP API: its paths, fields, types and error codes. Each entry is dated by the day it took effect; the newest comes first. A change can take effect on the day of its entry.

2026-11-18​

Topping up credits, and no estimate demanded of a call that charges nothing.

  • insufficient_balance, and quota_exhausted on a registered account, give the page of the Megido portal where an owner of your organization tops up its credits in the new field top_up_url.
  • A call that charges nothing, such as one the free quota pays in full, is no longer refused with confirmation_required when your organization requires an estimate for its tool.

2026-11-14​

Your organization's plan, its free quota and estimates above a price.

  • usage and capabilities name your organization's plan in the new field plan. capabilities gives the free quota of the plan per period in quota; usage gives it with what is left and the day it renews. Neither gives quota to an agent's task, whose calls the quota does not pay for.
  • A paid call of an index tool (search_cohorts, get_cohort, search_projects, get_project_card) reports what the free quota paid in meta.charge.from_quota.
  • New error codes: quota_exhausted (402), when the free quota does not cover a call of an index tool and the available credits do not cover the rest, and quote_outdated (409), when an estimate counted on more free quota than is left now. On a plan with a quota, quota_exhausted gives what is left of it in calls_left and first_seen_left, and, when a narrower call would fit in it, the parameter and the value to set in fitting_param and fitting_limit.
  • An estimate the free quota pays part of tells what it took in the new field from_quota.
  • An account without registration, made from a chat app, has no key and never calls the HTTP API; its answers are described all the same. Its usage and capabilities tell what registering gives in registration, and its quota_exhausted gives a one-time link to register this account at in sign_up_url, which works in any browser for 30 minutes, in place of price and available.
  • On an account without registration, the quality index and its axes of a card (index) and of index_explained, and the median index of a niche (members_index.median), come as bands, {low, high, label}, in place of numbers. Its filters on the index and its axes work by band, and a note in meta.notes names a threshold moved to a band's boundary.
  • A paid call tells what is left of the free quota after it in the new field meta.quota, with the day it renews; an estimate tells what is left before the call. It comes only on calls the free quota applies to.
  • capabilities gives limits.estimate_required_above when your organization requires an estimate of any call that may cost more than that many credits; such a call without a quote_token is refused with confirmation_required.

2026-11-09​

The HTTP API opens: every tool of the Megido MCP server at POST /v1/tools/<tool>, the tools your key may call at GET /v1/tools, and this reference at GET /v1/openapi.json.

View as Markdown