API Service et capacités

Prêt à servir. Un hôte en vidange répond 421 server_draining avec Retry-After : 1. Une défaillance d’une dépendance requise répond 500 not_ready avec Retry-After. Un schéma de base de données actif qui ne satisfait pas cette version (un index désiré manquant ou différent depuis plus de deux minutes) répond 500 schema_incompatible sans Retry-After : cela ne se résout pas en attendant.

Recherche dans la documentation officielle de screenRIG, les pages de screenrig.ai/docs, les types de problèmes, les tarifs et les autres pages destinées aux clients, et renvoie les sections les plus pertinentes, la meilleure d’abord, au plus limit (8 par défaut). Public : aucun identifiant n’est requis et l’appel n’est jamais facturé.

L’url d’un résultat est sa page (avec le fragment de la section lorsque la page en nomme un), section est le titre et snippet montre le texte autour de la correspondance ; lisez la page ou la section avec getDocsPage. Limité à 120 requêtes par IP cliente et par minute (IPv6 regroupées par /64).

Le corpus est rechargé toutes les 15 minutes ; avant le premier chargement, la route répond 500 not_ready avec Retry-After.

Renvoie une page de la documentation officielle ou, avec section, une seule de ses sections avec ses sous-sections, en Markdown. url est l’adresse de la page telle que la renvoie searchDocs, sa forme .md, ou seulement son chemin, avec ou sans #fragment (un fragment nomme la section lorsque section n’est pas fourni). section est un titre ou une ancre de la page, ou une partie d’un titre.

Une section est coupée à une fin de ligne dans la limite de 48 KiB, avec truncated true ; une page entière de plus de 48 KiB répond par son introduction et son plan, avec truncated true. sections liste les titres à lire ensuite (ceux de la page, ou les sous-titres de la section elle-même). Les pages et sections inconnues répondent 404 not_found.

Public, jamais facturé, et limité aux mêmes 120 requêtes par IP cliente et par minute que searchDocs.