# Forest Factory API – API Readiness Check

> Forest Factory API – API Readiness Check is a paid API for AI agents from http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run, paid per call via x402, $0.006/call, status unknown (last checked 2026-10-20).

Inspects a public URL or OpenAPI endpoint to determine if an API is reachable, parseable, and ready for discovery, returning structured readiness metadata.

## Facts

- Endpoint: POST https://http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run/api/readiness?utm_source=zero.xyz
- Price: $0.006/call
- Payment: x402
- Status: unknown
- Last checked: 2026-10-20
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/forest-factory-api-api-readiness-check-328fd64f
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_-GRLfOEWk3k26BWze-5r1

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability forest-factory-api-api-readiness-check-328fd64f -d '<json body>'
```

Example prompt: Can you check if the API at https://api.example.com is ready and discoverable — find its OpenAPI spec, auth types, and whether it's reachable and parseable?

## When to prefer this

Choose this endpoint when you need a machine-readable readiness signal for an API before attempting integration — especially when you want to auto-discover OpenAPI specs, validate parseability, enumerate auth types, and find developer portals from just a URL. Prefer this over generic HTTP probing tools when you need structured API-specific metadata rather than raw HTTP responses.

## Known failure modes

- URL is unreachable or returns non-200 — readiness state may be 'not_ready' or blockers listed
- OpenAPI URL is malformed or not an HTTP(S) URL — rejected by input schema pattern validation
- Target site blocks automated probing — empty candidates and operation count of 0
- Payment not attached — returns HTTP 402 with x402 PAYMENT-REQUIRED challenge
- OpenAPI spec found but not parseable — openapi_parse_valid returns false
- Provider request budget exceeded — provider_request_count hits limit

## How this service works

Machine-readable contract for active Forest paid capabilities. Unsigned paid calls return HTTP 402 with a PAYMENT-REQUIRED x402 challenge.

## Output

Returns a JSON object with a readiness state (e.g. 'ready'), list of servers, API doc URLs, auth types, OpenAPI version, operation count, developer portal links, OpenAPI candidates, parse validity, selected OpenAPI URL, provider request counts, plus metadata including cache status, provider name, check timestamp, and duration.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "properties": {
  "url": {
   "type": "string",
   "pattern": "^https?://",
   "maxLength": 2048,
   "minLength": 1,
   "description": "Public HTTP(S) URL to inspect, resolve, or compare."
  },
  "openapi_url": {
   "type": "string",
   "pattern": "^https?://",
   "maxLength": 2048,
   "minLength": 1,
   "description": "Public openapi url value used to scope this lookup."
  }
 }
}
```

## Response schema (JSON Schema)

```json
{
 "type": "json",
 "example": {
  "ok": true,
  "data": {
   "site": "example",
   "scope": "bounded_api_discovery_plus_single_openapi_preflight",
   "state": "ready",
   "servers": [],
   "api_docs": [],
   "blockers": [],
   "auth_docs": [],
   "auth_types": [],
   "openapi_version": "example",
   "operation_count": 0,
   "developer_portals": [],
   "openapi_reachable": false,
   "openapi_candidates": [],
   "openapi_parse_valid": false,
   "selected_openapi_url": "example",
   "provider_request_count": 0,
   "provider_request_budget": 11
  },
  "meta": {
   "cache": "miss",
   "provider": "bounded-web-discovery",
   "checked_at": "2026-01-01T00:00:00.000Z",
   "duration_ms": 0
  },
  "version": "1",
  "capability": "api.readiness"
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/forest-factory-api-api-readiness-check-328fd64f/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run](https://www.zero.xyz/host/http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run/llms.txt)
