OpenSearch

Opensearch Search

Structured search across one of the whitelisted mashup OpenSearch indices.

Use this when the LLM needs to look up enriched person / company records by attribute (domain, industry, country, hem). For the hot HEM-or-IP resolve path, prefer /opensearch/resolve — it's a single round trip and friendlier to cache. Contact/company mashup searches automatically apply the authenticated organization's deliverability protection policy.

post/opensearch/search

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/opensearch/search
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

index'mashup_contacts' | 'mashup_companies' | 'hem2contact' | 'ip2company' required

Logical index to search. Maps to a whitelisted physical alias.

filtersobject

Field equality filters. Scalar value -> term, list -> terms (OR). Use this to narrow by COMPANY_DOMAIN, COMPANY_INDUSTRY, hem, etc. Field names are the RAW index fields (UPPERCASE, e.g. COMPANY_INDUSTRY) -- not the friendly snake_case names used by /search.

fieldsstring[] nullable

Optional projection. If omitted, returns the full _source. Pass a list to reduce payload size when the LLM only needs a few columns.

sortobject[] nullable

Optional sort, list of {field: 'asc'|'desc'}. Required if you intend to paginate via cursor.

limitinteger

Hard-capped at 200.

track_total_hitsinteger nullable

Exact-count ceiling for the returned total. OMIT for the default behaviour (OpenSearch saturates total at 10000). Pass an integer ceiling 1-1000000 (e.g. 100000) to get an exact total up to that bound in the SAME round trip as the page. For a count with no page payload prefer POST /opensearch/count. Does NOT lift the from+size pagination depth -- use cursor (search_after) for that. (0 is rejected: it would mean 'disable tracking' in OpenSearch, which is what omitting it does.)

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.