Retrieval

Retrieval Query

Structured filters, semantic or hybrid search over the tenant's index.

Auth: X-API-Key (server-to-server; filters.endUserId is a trusted filter) OR a Bearer retrieval token (embedded SDK; a token-pinned end-user scope is ENFORCED server-side and cannot be widened by the request body). The tenant boundary always comes from the credential.

post/api/v1/retrieval/query

Request

  • Base URL: https://api.gemina.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.gemina.co/api/v1/retrieval/query
  • Auth: one of:
    • API key in header X-API-Key
    • OAuth 2 (password, token URL token)

Request body

mode'structured' | 'semantic' | 'hybrid'
textstring nullable

Natural-language query (semantic/hybrid modes)

topKinteger
skipinteger
limitinteger
sortField'issue_date' | 'due_date' | 'total_amount' | 'vendor_name' | 'created_at' nullable
sortMethod'asc' | 'desc'

Response

Successful Response

servedAtstring date-time
servedAtTimestampnumber
createdAtstring date-time nullable
createdAtTimestampnumber nullable

Changes

No recorded changes to this operation across all 1 revision of this API.