Skip to main content
GET
/
search
/
filter-capabilities
Filter Search Capabilities
curl --request GET \
  --url https://api.sixtyfour.ai/search/filter-capabilities
{
  "index_name": "<string>",
  "fields": [
    {
      "field": "<string>",
      "field_type": "<string>",
      "queryable": true,
      "sortable": true,
      "rangeable": true,
      "value_type": "<string>",
      "supports_top_values": true,
      "supports_exact_filter_snippet": true,
      "nested_path": "<string>",
      "sort_field": "<string>",
      "aggregation_field": "<string>",
      "related_fields": [
        "<string>"
      ],
      "preferred_for_exact_match": false
    }
  ],
  "nested_paths": [
    "<string>"
  ],
  "limits": {
    "max_query_depth": 123,
    "max_clause_count": 123,
    "max_terms_per_clause": 123,
    "max_sort_clauses": 123,
    "max_string_length": 123
  },
  "cache_ttl_seconds": 123,
  "generated_at_epoch_ms": 123,
  "mode": "company",
  "mapping_hash": "<string>",
  "simple_query_operators": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.sixtyfour.ai/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-api-key
string | null

Query Parameters

​
mode
string
default:company

Search mode: 'company' or 'people'.

​
refresh
boolean
default:false

Force a mapping refresh instead of using cached capabilities.

Response

Successful Response

Response describing supported filter-search DSL capabilities.

​
index_name
string
required

Public dataset identifier for company direct-filter queries.

​
fields
FilterFieldCapability · object[]
required

Unified per-field capabilities sorted alphabetically.

​
nested_paths
string[]
required

Allowed nested.path values for nested query clauses.

​
limits
FilterSearchLimits · object
required

Constraint values for guarded DSL validation.

​
cache_ttl_seconds
integer
required

Server cache TTL for mapping-derived capabilities.

​
generated_at_epoch_ms
integer
required

Epoch timestamp (ms) when these capabilities were derived.

​
mode
enum<string>
default:company

Search mode these capabilities apply to.

Available options:
people,
company
​
mapping_hash
string | null

Hash of mapping metadata used to derive this capability snapshot.

​
simple_query_operators
string[] | null

Supported MongoDB-style operators for simple_filters input.