Service & capabilities API

Serving readiness. A draining host answers 421 server_draining with Retry-After: 1. A required dependency failure answers 500 not_ready with Retry-After. A live database schema that does not satisfy this release (a desired index missing or different for more than two minutes) answers 500 schema_incompatible without Retry-After: it does not clear by waiting.

Searches the official screenRIG documentation, the pages of screenrig.ai/docs, the problem types, pricing and the other customer pages, and answers the best matching sections, best first, at most limit (8 by default). Public: no credential is needed and the call is never charged.

A hit's url is its page (with the section's fragment where the page names one), section is the heading and snippet shows the text around the match; read the page or the section with getDocsPage. Held to 120 requests per client IP per minute (IPv6 grouped by /64).

The corpus reloads every 15 minutes; before the first load the route answers 500 not_ready with Retry-After.

Answers an official documentation page, or with section one section of it with the sections under it, as Markdown. url is the page's address as searchDocs answers it, its .md form, or only its path, with or without a #fragment (a fragment names the section when section is not given). section is a heading or an anchor of the page, or part of a heading.

A section is cut at a line end within 48 KiB with truncated true; a whole page over 48 KiB answers its introduction with truncated true and its outline. sections lists the headings to read next (the page's, or the section's own sub-headings). Unknown pages and sections answer 404 not_found.

Public, never charged, and held to the same 120 requests per client IP per minute as searchDocs.