Entities

autocomplete

Autocomplete entity attributes.

Suggestions are derived from the values currently stored on entities the caller is allowed to read. A value only shows up while at least one entity carries it, so this endpoint reflects usage, not configuration.

To enumerate the label catalogue managed in the Label Builder (including labels that are not assigned to any entity yet, and excluding archived ones), use the Taxonomy endpoints instead: POST /v1/entity/taxonomies/classifications:search (taxonomiesClassificationsSearch) or GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete (taxonomyAutocomplete).

For attribute=_tags the distinct values are aggregated across all matching entities, hits is the exact number of distinct values (capped at 1000) and results are ordered by usage. For other attributes the 1000 most recently updated entities are scanned and hits is the number of distinct values found so far.

get/v1/entity:autocomplete

Request

  • Base URL
    https://entity.sls.epilot.io
  • URL
    https://entity.sls.epilot.io/v1/entity:autocomplete
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-id

Query parameters

anonymizeboolean

When true, anonymizes PII in the response: identifiers (names, emails, phone numbers, IBANs) are replaced with deterministic pseudonyms (stable within an org), addresses are generalized to postal code / city / country, and well-known free-text fields (e.g. note content) are redacted.

Useful for AI agents and data analysis use cases that must not access personal data.

Anonymization is forced (regardless of this parameter) when the access token was created with anonymize: true.

inputstring

Input to autocomplete (case-insensitive substring match)

attributestring required
Example:_tags

Autocomplete attribute

slugstring

URL-friendly identifier for the entity schema

Example:contact

Limit results to entity schema

sizeinteger

Maximum number of results to return

frominteger

Number of distinct values to skip, for paging through results when hits exceeds size. from + size may not exceed 1000.

Response

Success

hitsnumber

Number of distinct values matching the input. Exact (independent of size, capped at 1000) for _tags; for other attributes the number of distinct values collected so far, which may grow with size.

Example response

{
  "hits": 1,
  "results": [
    "value"
  ]
}

Changes