aboutsummaryrefslogtreecommitdiff
path: root/castle-search/README.md
diff options
context:
space:
mode:
authorIgor Soarez <igor@soarez.org>2026-11-18 04:55:45 +0000
committerIgor Soarez <igor@soarez.org>2026-11-18 04:55:45 +0000
commitb03415aafeea985561f3980f8b484173530a05f8 (patch)
tree3748f62ae52a5c4d7906ec3268bb8b2863a5114a /castle-search/README.md
parent4c1f9b4ea943d03e9610f13344c372e630db5b9d (diff)
castle-search: search X over HTTP, through the browser's signed-in session
POST /x-search reads x.com/search in a background tab: posts with their link, author, time, text, counts and quoted post, scrolling for up to 20. GET /openapi.json describes it for Open WebUI's tool servers. Signed out, an X error page or a stuck page are errors, never an empty list.
Diffstat (limited to 'castle-search/README.md')
-rw-r--r--castle-search/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/castle-search/README.md b/castle-search/README.md
index 7e4fd5c..0e45aaf 100644
--- a/castle-search/README.md
+++ b/castle-search/README.md
@@ -47,6 +47,19 @@ switch engines, because this protocol has no field for one. There is no
authentication: bind it to loopback (the default) or a trusted address.
`GET /health` answers `{"status": true}`.
+### X search
+
+`POST /x-search` searches X (Twitter) instead: `{"query": "from:nasa", "count":
+10, "sort": "latest"}` in, `{"query", "sort", "posts": [...]}` out, each post
+with its link, author, time, text, counts and any quoted post. The query is X's
+own search syntax. It needs the browser signed in to X — X serves search to
+nobody else — and it says so when it is not, rather than returning nothing.
+`GET /openapi.json` describes it, so Open WebUI can offer it as a tool. Free per
+search, where xAI's own X search charges per post returned.
+
+X keeps only the posts near the screen in the page, so it scrolls and collects
+by link, up to 20 posts. A search takes 4–7 s.
+
## Engines
Four, with independent indexes and independent rate limits. That last part is