Reference

OpenAPI Reference

Generated OpenAPI document location and generation behavior.

The API server publishes OpenAPI at:

GET /openapi.json

The document is generated by Hono zod-openapi route definitions in @isplay/server.

Local Fetch

npx isplay start
curl http://127.0.0.1:7373/openapi.json

What It Covers

The generated document covers registered HTTP routes, request bodies, route parameters, query parameters, response schemas, and structured error responses for route definitions.

What Still Needs Human Docs

OpenAPI does not explain:

  • Evidence strength.
  • Replay policy tradeoffs.
  • Fixture provenance.
  • Low-N experiment caveats.
  • Adapter capability differences.
  • Current executor limitations.

Use OpenAPI for exact HTTP shape. Use the concept and guide pages for interpretation.

API Client Reference

Programmatic HTTP client options, resources, methods, and errors.

SDK Reference

Initialization, run context, capture lifecycle, surface methods, API client behavior, and adapter interaction.

On this page

Local FetchWhat It CoversWhat Still Needs Human Docs