Skip to main content

Field Autocomplete

Autocomplete field names from the registry ranked by relevance and occurrence count. Power field picker UIs with type-ahead search.

Search and filter documents by their extracted field values. Includes field autocomplete, document filtering with composable conditions, global omnisearch, and saved filter management.

GET/fields/autocomplete

Response

Response fields

fieldsarrayArray of matching field objects ranked by relevance.
fields[].fieldIdstringUnique field registry ID.
fields[].canonicalNamestringCanonical field name (lowercase, underscore-separated).
fields[].displayNamestringHuman-readable display name.
fields[].dataTypestringField data type (string, number, date, boolean).
fields[].tierintegerRegistry tier (1 = high confidence, higher = lower confidence).
fields[].occurrenceCountintegerNumber of documents containing this field.
fields[].matchSourcestringHow the field matched the query (canonical, alias, etc.).
fields[].sampleValuesstring[]Up to 3 representative values from the field.

Response

{
  "fields": [
    {
      "fieldId": "fld_a1b2c3d4",
      "canonicalName": "supplier_name",
      "displayName": "Supplier Name",
      "dataType": "string",
      "tier": 1,
      "occurrenceCount": 1842,
      "matchSource": "canonical",
      "sampleValues": ["Acme Corp", "Globex Inc", "Initech"]
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Field Values
Filter Documents