Openapi Operation-contract
Inspect the declared request and response contract for one exact OpenAPI or Swagger operation before integration. Returns parameters, request-body content types, response statuses/content types and declared security scheme names without executing the endpoint or resolving external references.
Forest exposes this capability as a deterministic machine-readable API for software agents. Discovery is free; execution uses the canonical paid endpoint below. The live x402 challenge is the source of truth for payment terms.
$0.003 / callPOST /openapi/operation-contractx402 · Base
Typical agent tasks
This capability is intended for bounded machine decisions such as:
- inspect required parameters and request body for one documented API endpoint
- read response statuses content types and authentication declarations for an OpenAPI operation
- get the machine contract for a method and path before making an API request
- understand an API endpoint input output and auth contract without executing it
What Forest guarantees
- one bounded public OpenAPI or Swagger document fetch
- bounded operation metadata only with explicit summary-only state when details are unavailable
- no discovered API operation is invoked
Boundaries
- reference resolution or full schema expansion
- authenticated API usability or runtime endpoint availability
- rich operation detail from the intentionally simple YAML fallback parser
Machine contract
The request and response schemas are published in the canonical OpenAPI document. This page shows a representative input from the same production manifest.
Input example
{
"url": "https://http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run/openapi.json",
"method": "POST",
"path": "/widgets"
}
Canonical paid endpoint
https://http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run/openapi/operation-contract
Related capabilities
- Openapi Breaking-change — Compare two public OpenAPI or Swagger contracts and determine whether the API update contains directly observable breaking compatibility changes. Detects removed operations, newly required request inputs, narrowed inline enums, removed content types or successful responses and tightened authentication; unsupported compatibility questions remain unknown. No API operation is executed.
- Openapi Operation-resolve — Look up one exact HTTP method and path in a public OpenAPI or Swagger contract and report whether that documented API endpoint exists. This is a contract/endpoint existence check only; Forest reads the specification and never invokes the API operation.
- Openapi Schema-state — Fingerprint the structural machine contract of a public OpenAPI or Swagger specification and compare it with an optional previous SHA-256 fingerprint to detect API contract drift. Paths, operations, parameters, security and component schema structure are tracked while documentation-only text and examples are ignored. No API operation is executed.
- Openapi Payload-validate — Validate one caller-supplied JSON request or response payload against the documented JSON schema for one exact OpenAPI or Swagger operation. Forest fetches only the supplied public specification, never invokes the described API operation, resolves only bounded local references, and reuses the same deterministic schema subset as json.validate.
- Openapi Preflight — Validate a public OpenAPI or Swagger document before integration: verify reachability and parseability, summarize declared API operations, servers and authentication metadata, and report whether the specification is usable for machine integration. It does not call any documented API operation.
- Api Readiness — Compose bounded API discovery with one deterministic OpenAPI or Swagger preflight into a concise agent-readiness state. The check does not authenticate, call discovered API operations, or prove business-level API correctness.