ZincSearch · Schema
meta.ZincQueryForSDK
CompanySearchFull-Text SearchOpen SourceSelf-HostedElasticsearch Compatible
Properties
| Name | Type | Description |
|---|---|---|
| _source | array | true, false, ["field1", "field2.*"] |
| aggs | object | |
| explain | boolean | |
| fields | array | ["field1", "field2.*", {"field": "fieldName", "format": "epoch_millis"}] |
| from | integer | |
| highlight | object | |
| query | object | |
| size | integer | |
| sort | array | "_score", ["+Year","-Year", {"Year": "desc"}, "Date": {"order": "asc"", "format": "yyyy-MM-dd"}}"}] |
| timeout | integer | |
| track_total_hits | boolean |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/zincsearch/json-schema/zincsearch-meta-zinc-query-for-sdk-schema.json",
"title": "meta.ZincQueryForSDK",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/zincsearch-search-api-openapi.yml#/components/schemas/meta.ZincQueryForSDK",
"type": "object",
"properties": {
"_source": {
"description": "true, false, [\"field1\", \"field2.*\"]",
"type": "array",
"items": {
"type": "string"
}
},
"aggs": {
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.Aggregations"
}
},
"explain": {
"type": "boolean"
},
"fields": {
"description": "[\"field1\", \"field2.*\", {\"field\": \"fieldName\", \"format\": \"epoch_millis\"}]",
"type": "array",
"items": {
"type": "string"
}
},
"from": {
"type": "integer"
},
"highlight": {
"$ref": "#/$defs/meta.Highlight"
},
"query": {
"$ref": "#/$defs/meta.QueryForSDK"
},
"size": {
"type": "integer"
},
"sort": {
"description": "\"_score\", [\"+Year\",\"-Year\", {\"Year\": \"desc\"}, \"Date\": {\"order\": \"asc\"\", \"format\": \"yyyy-MM-dd\"}}\"}]",
"type": "array",
"items": {
"type": "string"
}
},
"timeout": {
"type": "integer"
},
"track_total_hits": {
"type": "boolean"
}
},
"$defs": {
"aggregation.HistogramBound": {
"type": "object",
"properties": {
"max": {
"description": "maximum",
"type": "number"
},
"min": {
"description": "minimum",
"type": "number"
}
}
},
"meta.AggregationAutoDateHistogram": {
"type": "object",
"properties": {
"buckets": {
"type": "integer"
},
"field": {
"type": "string"
},
"format": {
"description": "format key_as_string",
"type": "string"
},
"keyed": {
"type": "boolean"
},
"minimum_interval": {
"description": "minute,hour,day,week,month,quarter,year",
"type": "string"
},
"time_zone": {
"description": "time_zone",
"type": "string"
}
}
},
"meta.AggregationDateHistogram": {
"type": "object",
"properties": {
"calendar_interval": {
"description": "minute,hour,day,week,month,quarter,year",
"type": "string"
},
"extended_bounds": {
"$ref": "#/$defs/aggregation.HistogramBound"
},
"field": {
"type": "string"
},
"fixed_interval": {
"description": "ms,s,m,h,d",
"type": "string"
},
"format": {
"description": "format key_as_string",
"type": "string"
},
"hard_bounds": {
"$ref": "#/$defs/aggregation.HistogramBound"
},
"interval": {
"description": "ms,s,m,h,d",
"type": "string"
},
"keyed": {
"type": "boolean"
},
"min_doc_count": {
"type": "integer"
},
"size": {
"type": "integer"
},
"time_zone": {
"description": "time_zone",
"type": "string"
}
}
},
"meta.AggregationDateRange": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"format": {
"description": "format the `to` and `from` values to `_as_string`, and used to format `keyed response`",
"type": "string"
},
"keyed": {
"type": "boolean"
},
"ranges": {
"description": "refer",
"type": "array",
"items": {
"$ref": "#/$defs/meta.DateRange"
}
},
"time_zone": {
"description": "refer",
"type": "string"
}
}
},
"meta.AggregationHistogram": {
"type": "object",
"properties": {
"extended_bounds": {
"$ref": "#/$defs/aggregation.HistogramBound"
},
"field": {
"type": "string"
},
"hard_bounds": {
"$ref": "#/$defs/aggregation.HistogramBound"
},
"interval": {
"type": "number"
},
"keyed": {
"type": "boolean"
},
"min_doc_count": {
"type": "integer"
},
"offset": {
"type": "number"
},
"size": {
"type": "integer"
}
}
},
"meta.AggregationIPRange": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"keyed": {
"type": "boolean"
},
"ranges": {
"type": "array",
"items": {
"$ref": "#/$defs/meta.IPRange"
}
}
}
},
"meta.AggregationMetric": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"weight_field": {
"description": "Field name to be used for setting weight for primary field for weighted average aggregation",
"type": "string"
}
}
},
"meta.AggregationRange": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"keyed": {
"type": "boolean"
},
"ranges": {
"type": "array",
"items": {
"$ref": "#/$defs/meta.Range"
}
}
}
},
"meta.Aggregations": {
"type": "object",
"properties": {
"aggs": {
"description": "nested aggregations",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.Aggregations"
}
},
"auto_date_histogram": {
"$ref": "#/$defs/meta.AggregationAutoDateHistogram"
},
"avg": {
"$ref": "#/$defs/meta.AggregationMetric"
},
"cardinality": {
"$ref": "#/$defs/meta.AggregationMetric"
},
"count": {
"$ref": "#/$defs/meta.AggregationMetric"
},
"date_histogram": {
"$ref": "#/$defs/meta.AggregationDateHistogram"
},
"date_range": {
"$ref": "#/$defs/meta.AggregationDateRange"
},
"histogram": {
"$ref": "#/$defs/meta.AggregationHistogram"
},
"ip_range": {
"description": "TODO: not implemented",
"allOf": [
{
"$ref": "#/$defs/meta.AggregationIPRange"
}
]
},
"max": {
"$ref": "#/$defs/meta.AggregationMetric"
},
"min": {
"$ref": "#/$defs/meta.AggregationMetric"
},
"range": {
"$ref": "#/$defs/meta.AggregationRange"
},
"sum": {
"$ref": "#/$defs/meta.AggregationMetric"
},
"terms": {
"$ref": "#/$defs/meta.AggregationsTerms"
},
"weighted_avg": {
"$ref": "#/$defs/meta.AggregationMetric"
}
}
},
"meta.AggregationsTerms": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"order": {
"description": "{ \"_count\": \"asc\" }",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"size": {
"type": "integer"
}
}
},
"meta.BoolQueryForSDK": {
"type": "object",
"properties": {
"filter": {
"description": "query, [query1, query2]",
"type": "array",
"items": {
"$ref": "#/$defs/meta.QueryForSDK"
}
},
"minimum_should_match": {
"description": "only for should",
"type": "number"
},
"must": {
"description": "query, [query1, query2]",
"type": "array",
"items": {
"$ref": "#/$defs/meta.QueryForSDK"
}
},
"must_not": {
"description": "query, [query1, query2]",
"type": "array",
"items": {
"$ref": "#/$defs/meta.QueryForSDK"
}
},
"should": {
"description": "query, [query1, query2]",
"type": "array",
"items": {
"$ref": "#/$defs/meta.QueryForSDK"
}
}
}
},
"meta.DateRange": {
"type": "object",
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
}
},
"meta.ExistsQuery": {
"type": "object",
"properties": {
"field": {
"type": "string"
}
}
},
"meta.FuzzyQuery": {
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"fuzziness": {
"description": "auto, 1,2,3,n"
},
"prefix_length": {
"type": "number"
},
"value": {
"type": "string"
}
}
},
"meta.Highlight": {
"type": "object",
"properties": {
"fields": {
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.Highlight"
}
},
"fragment_size": {
"type": "integer"
},
"number_of_fragments": {
"type": "integer"
},
"post_tags": {
"type": "array",
"items": {
"type": "string"
}
},
"pre_tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"meta.IPRange": {
"type": "object",
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
}
},
"meta.IdsQuery": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"meta.MatchAllQuery": {
"type": "object"
},
"meta.MatchBoolPrefixQuery": {
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"boost": {
"type": "number"
},
"query": {
"type": "string"
}
}
},
"meta.MatchNoneQuery": {
"type": "object"
},
"meta.MatchPhrasePrefixQuery": {
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"boost": {
"type": "number"
},
"query": {
"type": "string"
}
}
},
"meta.MatchPhraseQuery": {
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"boost": {
"type": "number"
},
"query": {
"type": "string"
}
}
},
"meta.MatchQuery": {
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"boost": {
"type": "number"
},
"fuzziness": {
"description": "auto, 1,2,3,n"
},
"operator": {
"description": "or(default), and",
"type": "string"
},
"prefix_length": {
"type": "number"
},
"query": {
"type": "string"
}
}
},
"meta.MultiMatchQuery": {
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"boost": {
"type": "number"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"minimum_should_match": {},
"operator": {
"description": "or(default), and",
"type": "string"
},
"query": {
"type": "string"
},
"type": {
"description": "best_fields(default), most_fields, cross_fields, phrase, phrase_prefix, bool_prefix",
"type": "string"
}
}
},
"meta.PrefixQuery": {
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"value": {
"description": "You can speed up prefix queries using the index_prefixes mapping parameter.",
"type": "string"
}
}
},
"meta.QueryForSDK": {
"type": "object",
"properties": {
"bool": {
"description": ".",
"allOf": [
{
"$ref": "#/$defs/meta.BoolQueryForSDK"
}
]
},
"exists": {
"description": ".",
"allOf": [
{
"$ref": "#/$defs/meta.ExistsQuery"
}
]
},
"fuzzy": {
"description": "simple, PrefixQuery",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.FuzzyQuery"
}
},
"ids": {
"description": ".",
"allOf": [
{
"$ref": "#/$defs/meta.IdsQuery"
}
]
},
"match": {
"description": "simple, MatchQuery",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.MatchQuery"
}
},
"match_all": {
"description": "just set or null",
"allOf": [
{
"$ref": "#/$defs/meta.MatchAllQuery"
}
]
},
"match_bool_prefix": {
"description": "simple, MatchBoolPrefixQuery",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.MatchBoolPrefixQuery"
}
},
"match_none": {
"description": "just set or null",
"allOf": [
{
"$ref": "#/$defs/meta.MatchNoneQuery"
}
]
},
"match_phrase": {
"description": "simple, MatchPhraseQuery",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.MatchPhraseQuery"
}
},
"match_phrase_prefix": {
"description": "simple, MatchPhrasePrefixQuery",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.MatchPhrasePrefixQuery"
}
},
"multi_match": {
"description": ".",
"allOf": [
{
"$ref": "#/$defs/meta.MultiMatchQuery"
}
]
},
"prefix": {
"description": ".",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.PrefixQuery"
}
},
"query_string": {
"description": ".",
"allOf": [
{
"$ref": "#/$defs/meta.QueryStringQuery"
}
]
},
"range": {
"description": "simple, FuzzyQuery",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.RangeQueryForSDK"
}
},
"regexp": {
"description": "simple, FuzzyQuery",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.RegexpQuery"
}
},
"simple_query_string": {
"description": ".",
"allOf": [
{
"$ref": "#/$defs/meta.SimpleQueryStringQuery"
}
]
},
"term": {
"description": "simple, TermQuery",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.TermQueryForSDK"
}
},
"terms": {
"description": ".",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.TermsQuery"
}
},
"wildcard": {
"description": "simple, WildcardQuery",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/meta.WildcardQuery"
}
}
}
},
"meta.QueryStringQuery": {
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"boost": {
"type": "number"
},
"default_field": {
"type": "string"
},
"default_operator": {
"description": "or(default), and",
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"query": {
"type": "string"
}
}
},
"meta.Range": {
"type": "object",
"properties": {
"from": {
"type": "number"
},
"to": {
"type": "number"
}
}
},
"meta.RangeQueryForSDK": {
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"format": {
"description": "Date format used to convert date values in the query.",
"type": "string"
},
"gt": {
"description": "string, float64",
"type": "string"
},
"gte": {
"description": "string, float64",
"type": "string"
},
"lt": {
"description": "string, float64",
"type": "string"
},
"lte": {
"description": "string, float64",
"type": "string"
},
"time_zone": {
"description": "used to convert date values in the query to UTC.",
"type": "string"
}
}
},
"meta.RegexpQuery": {
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"flags": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"meta.SimpleQueryStringQuery": {
"type": "object",
"properties": {
"all_fields": {
"type": "boolean"
},
"analyzer": {
"type": "string"
},
"boost": {
"type": "number"
},
"default_operator": {
"description": "or(default), and",
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"query": {
"type": "string"
}
}
},
"meta.TermQueryForSDK": {
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"case_insensitive": {
"type": "boolean"
},
"value": {
"type": "string"
}
}
},
"meta.TermsQuery": {
"type": "object",
"additionalProperties": true
},
"meta.WildcardQuery": {
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"value": {
"type": "string"
}
}
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/zincsearch-meta-zinc-query-for-sdk"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.