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.
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.006 / callPOST /api/readinessx402 · Base
Typical agent tasks
This capability is intended for bounded machine decisions such as:
- is this public API ready for an agent to use
- discover and validate the best OpenAPI contract for this site
- can I automate against this site API without probing its operations
What Forest guarantees
- at most eleven bounded public HTTP requests across discovery and one OpenAPI preflight
- deterministic OpenAPI-preferred candidate selection unless the caller supplies an explicit override
- no discovered API operation is invoked
Boundaries
- authenticated API usability
- business-level API correctness
- JavaScript-rendered documentation discovery
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/fixtures/page",
"openapi_url": "https://http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run/openapi.json"
}
Canonical paid endpoint
https://http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run/api/readiness
Related capabilities
- Api Discover — Discover the callable public API behind a developer or documentation page: identify candidate API base URLs, developer portals, machine-readable API docs and authentication documentation for integration setup.
- Docs Discover — Discover machine-readable integration documentation from a public developer/docs page: llms.txt, Markdown alternates, API/auth docs, OpenAPI or Swagger specifications, and MCP candidates. Candidates are returned only after bounded verification. Maximum 10 HTTP requests; no JavaScript, recursive crawl or authenticated content.
- 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-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.
- 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 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.