API de Servicio y capacidades

Preparación para servir. Un host en drenaje responde 421 server_draining con Retry-After: 1. Una falla de dependencia requerida responde 500 not_ready con Retry-After. Un esquema de base de datos activo que no satisface esta versión (un índice deseado ausente o diferente por más de dos minutos) responde 500 schema_incompatible sin Retry-After: no se resuelve esperando.

Busca en la documentación oficial de screenRIG, las páginas de screenrig.ai/docs, los tipos de problemas, los precios y las demás páginas para clientes, y devuelve las secciones que mejor coinciden, la mejor primero, como máximo limit (8 por defecto). Público: no se necesita ninguna credencial y la llamada nunca se cobra.

La url de un resultado es su página (con el fragmento de la sección cuando la página nombra uno), section es el encabezado y snippet muestra el texto alrededor de la coincidencia; lea la página o la sección con getDocsPage. Limitado a 120 solicitudes por IP de cliente y minuto (IPv6 agrupadas por /64).

El corpus se recarga cada 15 minutos; antes de la primera carga, la ruta responde 500 not_ready con Retry-After.

Devuelve una página de la documentación oficial o, con section, una sola de sus secciones con las secciones que contiene, en Markdown. url es la dirección de la página tal como la devuelve searchDocs, su forma .md o solo su ruta, con o sin #fragment (un fragmento nombra la sección cuando no se indica section). section es un encabezado o un ancla de la página, o parte de un encabezado.

Una sección se corta en un final de línea dentro de 48 KiB, con truncated true; una página completa de más de 48 KiB responde con su introducción y su esquema, con truncated true. sections lista los encabezados que leer a continuación (los de la página o los subencabezados de la propia sección). Las páginas y secciones desconocidas responden 404 not_found.

Público, nunca se cobra y está limitado a las mismas 120 solicitudes por IP de cliente y minuto que searchDocs.