For the complete BrainAPI documentation index, see llms.txt. A markdown version of any docs page is available by appending .md to its URL. Docs MCP: /docs/mcp.
BrainAPI Public API
Unauthenticated service health and the guarded read-only documentation search sandbox.
Search the fixed public demo brain using passages-only BM25 retrieval.
This endpoint never accepts a caller-selected brain and exposes no write path. Production applies an additional per-client rate limit at the edge.
Query Parameters
Search query over the public BrainAPI documentation corpus.
1 <= length <= 500Number of public documentation passages to return (maximum 10).
1 <= value <= 1010Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/demo/search?query=string"{ "channel_lists": { "property1": [ "string" ], "property2": [ "string" ] }, "facets": { "property1": { "property1": 0, "property2": 0 }, "property2": { "property1": 0, "property2": 0 } }, "hits": [ { "channel": "string", "extras": {}, "id": "string", "labels": [ "string" ], "node_id": "string", "score": 0, "scores": { "bm25": 0, "cc": 0, "dense": 0, "graph": 0, "personalize": 0, "plugin": { "property1": 0, "property2": 0 }, "rerank": 0, "rrf": 0 }, "snippet": "string" } ], "node_ids": [ "string" ], "stage_timings": {}}Return public liveness metadata without accessing customer data.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/health"{ "service": "string", "status": "string", "version": "string"}Last updated on