agent API guide

About

This plugin generates a live API reference and documentation tailored for Payload CMS projects. It reads the configuration of a Payload setup and produces various outputs, including an interactive API browser, OpenAPI specification, and a concise guide for developers and AI coding agents. The generated documentation helps to eliminate misunderstandings regarding the Payload REST API calls, providing project-specific examples and instructions. Key outputs include a human-readable HTML guide, an OpenAPI 3.1 specification file, and structured maps for AI agents. Each collection's details, such as field names and types, relationships, and authentication requirements, are captured, allowing for accurate querying. This functionality is useful for developers who need detailed, project-specific API information as well as for AI agents that require clear querying patterns. Installation requires Payload version 3.85.0 or later, and setup involves integrating the plugin into the Payload config. The plugin allows for customization options such as enabling or disabling the guide and setting a custom title.

Package info

Package name

@matija2209/payload-agent-api-guide

Latest version

1.0.1

Unpacked size

121 kB

License

MIT

Weekly downloads

14

Last publish

Jun 4, 2026