Skip to navigation
GIDEON API 1.0Search

/query

View as Markdown

Runs a keyword search against GIDEON content. The API returns { "data": ... } where data is the search payload from the search service (shape may include hits, facets, and metadata depending on the query).

Request body (JSON)

FieldRequiredDescription
queryYesSearch text.
offsetNoStarting offset for paginated results.
limitNoPage size.
module_filterNoNarrow results by module (e.g. diseases).
record_type_filterNoNarrow by record type (e.g. graph, image).

Errors

  • 400 — Body is not valid JSON or query is missing/empty.
  • 503 — Search service is not configured on the server.
  • 502 — Search service could not be reached or returned an error.

Non-success responses may use { "error": { "message", "status" } }.

Authentication

Authorizationstring
API Key authentication via header

Request

This endpoint expects an object.
limitintegerRequired
querystringRequired
offsetintegerRequired
module_filterstringRequired
record_type_filterstringRequired

Response

OK
dataobject