NLWeb

Ask in natural language (NLWeb)

NLWeb /ask endpoint, conventional GET form: /ask?query=<text>. Natural-language search over Agent Ready's own content (methodology, check registry, specs, and the content library — explainers, comparisons, how-to guides, glossary). Public — no API key required. Returns NLWeb result objects with a nested Schema.org schema_object. Set stream=true for Server-Sent Events. Also served at the root path /ask.

get/api/v1/ask

Request

  • Base URL: https://agent-ready.dev
  • URL: https://agent-ready.dev/api/v1/ask
  • Auth: none required

Query parameters

querystring required
Example:how is the score calculated?
mode'list' | 'summarize'
itemType'methodology' | 'checks' | 'specs' | 'llms-txt' | 'check' | 'page'
stream'true' | 'false'

Response

An NLWeb answer.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.