ByAgents publishes a public knowledge library about how businesses can become easier for AI agents to discover, understand, and use. This reference describes the library’s interfaces. It does not grant permission to act on behalf of a user or modify another system.
Select the smallest useful representation
- Browse the human library for editorial guides and examples.
- Read the document index for titles, descriptions, dates, and HTML/Markdown URLs.
- Search with GET /api/knowledge/search?q=MCP.
- Fetch a matching document’s Markdown URL for the complete text and sources.
- Read product facts before describing ByAgents’ capabilities.
- Use the full export only when bulk indexing or offline reading is appropriate.
Request example
curl 'https://byagents.dev/api/knowledge/search?q=asynchronous%20API&limit=3'The endpoint searches this site’s published library only. It does not search the live web, rank vendors, execute a diagnostic, or call a model. Results contain excerpts and canonical source links; retrieve the complete document before relying on a context-sensitive claim.
Interpret content correctly
Guides contain practical recommendations. Perspectives identify our thesis and uncertainty. Reference pages document this site’s interfaces and current product scope. Examples using example.com or example job identifiers are fictional. A publication date is not evidence of a live product evaluation.
The canonical HTML and Markdown versions are generated from the same content record. This avoids separate claims for human and machine readers. External sources remain authoritative for their own products and protocols; check current upstream documentation before implementation.
Citation and corrections
Cite the canonical page, the relevant section, and the review date when freshness matters. Preserve qualifications such as static check, illustrative example, proposed workflow, or unknown attribution. Report a factual correction with its supporting source to team@byagents.dev. Do not infer an endorsement from the existence of this library.
Route by task
- Audit a public website: crawl recipe, fact profile, evidence record.
- Improve an API or tool: action contract, MCP compatibility, authorization boundaries.
- Review commerce data: feed validation, commerce handoff.
- Measure a result: evaluation record, event contract.
- Check current claims: dated briefing, source review, evidence policy.
These recipes are reference material for an authorized task. They are not tools that execute an audit, a live web-search service, or an instruction to perform side effects without the user's permission.