API versions#
Compatibility#
Additive endpoints, optional parameters, response fields and new extensible codes normally remain in the current major version. Clients should ignore unknown response fields and handle unknown codes using HTTP status. A change is not automatically safe merely because it is additive: new required semantics must preserve existing callers.Removing/renaming fields, changing types, narrowing accepted parameters or changing metric definitions requires a new field or major version with an explicit migration path. Backend implementation fixes that restore the documented metric are documented in release notes rather than silently introducing a different definition.The OpenAPI info.version uses semantic versions for the published contract document: patch for description/schema corrections that align with unchanged behavior, minor for compatible features, major for breaking changes. It is independent from the OpenAPI syntax version (3.1.0 or a compatible 3.0.3 export), MCP protocol revision and MCP server implementation version.Configurable allowances are reported in project limits. The 500-response market cursor cap is a fixed contract limit. Tightening a limit can affect integrations and requires release notice; do not infer compatibility from a version number alone.Deprecation#
No compatibility period is promised for previous gateway addresses. Current public addresses are listed in Authentication and MCP Integration. Deprecation and Sunset headers are added only when a real deprecation schedule exists; absence of a header is not a retirement announcement. The Deprecation header uses an RFC 9745 date value, not a boolean.Changelog#
| Contract version | Change |
|---|
| 1.0.1 | Align relationship type, cursor metadata, remaining allowance and nullable export with actual responses; remove an unimplemented evidenceRemainingToday field from the schema/examples. Runtime metrics and fixed 500-record cap are unchanged. |
| 1.0.0 | Initial data API contract. |
MCP entry protection now separates recently verified and unverified traffic and bounds stalled responses. This is an admission-policy update; it does not change business statistics or backend team allowances.Modified at 2026-11-05 02:43:30