OKF guide

OpenAPI to OKF

Turn OpenAPI specs into endpoint-focused OKF files for agent-readable API documentation.

OpenAPI to OKF

OpenAPI to OKF conversion splits an API specification into endpoint, schema, and authentication concept files. Each endpoint can include method, path, operation ID, tags, parameters, request bodies, responses, examples, and links to related schemas so agents retrieve the exact API context they need.

Why convert API specs

Agents need endpoint context in small, retrievable files. OKF makes operations easier to search, cite, and package alongside product docs.

Current support

OKFConverter supports pasted or uploaded OpenAPI JSON/YAML and generates endpoint, schema, and auth files.

FAQ

Can OKFConverter parse OpenAPI YAML?

Yes. OKFConverter accepts pasted or uploaded OpenAPI JSON and YAML, then generates endpoint, schema, and auth-focused OKF files.

Why split API docs into OKF files?

Splitting operations into smaller files helps AI agents retrieve one endpoint, schema, or auth rule instead of a giant reference document.

Sources

Next step

Use OKFConverter to generate a structured bundle, then run the validator before giving the files to an AI agent, support bot, internal search system, or retrieval pipeline.