Search
Run ranked retrieval over canonical documents and passages.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Optional client session identifier.
Body
The search query, phrased as the user or agent would ask it. Drives ranking and passage selection even when search_queries supplies a rewrite.
1"linux kernel amd gpu suspend"
Calling model identifier, recorded for analytics and ranking tuning.
Structured filters. Keys: country (two-letter code such as 'us' or 'de', scoping results to a market), language (two-letter code such as 'en'), exact_match (boolean; quotes the query so the index matches it verbatim).
Recency requirements. Keys: published_after (RFC 3339 timestamp or YYYY-MM-DD date; only content published after it) and freshness (coarse window code pd, pw, pm, or py for past day, week, month, or year; ignored when published_after is set).
Maximum number of ranked results to return. The response carries fewer when the index has fewer matches.
1 <= x <= 50Optional response shaping: verbosity preset and serialized-size budget.
Which indexes to search. Omit it for the web index. Additive: existing clients are unaffected.
Caller-provided query rewrites. The first entry replaces query as the text sent to the search index; query still drives reranking and passage selection. All entries are visible to the server-side query rewriter.
Client session identifier (UUID). Groups related search, document, and feedback calls; equivalent to the X-Session-ID header. When omitted, the server generates one and echoes it back as session_id.
Domain allow/deny policy. Keys: include_domains (array of domains; with require_domain_match true, results outside them are dropped, and a single entry is also sent to the index as a site: operator), exclude_domains (array of domains whose results are always dropped), require_domain_match (boolean). Domains match their subdomains; a leading www. is ignored.
Response
Search results.
A URL to the JSON Schema for this object.
"https://alpha.api.trycaesar.com/SearchResponse.json"