retrievals

Execute Retrieval

post/api/retrievals/execute

Request

Base URL: https://www.gateco.ai (the document declares no server; this is the origin it was published from)
URL: https://www.gateco.ai/api/retrievals/execute
Auth: OAuth 2 (password, token URL /api/auth/login)

query_vectornumber[] nullable

Pre-computed query embedding. If omitted, server embeds query text.

querystring nullable

Natural language query. Required if query_vector is omitted.

principal_idstring required

connector_idstring required

top_kinteger

filtersobject nullable

include_unresolvedboolean

Include unresolved results for diagnostics

search_mode'vector' | 'keyword' | 'hybrid' | 'grep'

Search mode: vector (ANN), keyword (FTS), hybrid (vector+keyword), grep (exact match)

alphanumber nullable

Hybrid weight: 1.0=all-vector, 0.0=all-keyword. Only for hybrid mode.

pattern_type'substring' | 'regex' nullable

Grep pattern type. Only for grep mode.

case_sensitiveboolean

Case-sensitive grep matching. Only for grep mode.

content_mode'inline' | 'ref' nullable

Content delivery mode. 'ref' returns signed URLs instead of inline content (Enterprise only).

Successful Response

unknown required

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