# Azure AI Search API

> Azure AI Search API on Apizie: 63 endpoints (Lists all aliases available for a search service., Creates a new search alias., Retrieves an alias definition., Creates a new search alias or updates an alias if it already exists., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:azure-search-search/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-search-search`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://zieapi.vercel.app/api/cloud/azure-search-search
- OpenAPI: https://zieapi.vercel.app/api/cloud/azure-search-search/openapi.json

Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.

## Endpoints

### Lists all aliases available for a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/aliases-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| search | string | no | A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no… |
| pageSize | integer | no | The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default. |
| searchType | string | no | Specifies how the search parameter is interpreted. Currently only 'prefix' is supported. |

### Creates a new search alias.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/aliases-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| body | object | yes | JSON request body |

### Retrieves an alias definition.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/aliases-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| aliasName | string | yes | The name of the alias. |

### Creates a new search alias or updates an alias if it already exists.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/aliases-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| aliasName | string | yes | The name of the alias. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |
| Prefer | string | yes | For HTTP PUT requests, instructs the service to return the created/updated resource on success. |
| body | object | yes | JSON request body |

### Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery…
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/aliases-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| aliasName | string | yes | The name of the alias. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

### Lists all datasources available for a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/data-sources-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| $select | array | no | Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The… |
| search | string | no | A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no… |
| pageSize | integer | no | The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default. |
| searchType | string | no | Specifies how the search parameter is interpreted. Currently only 'prefix' is supported. |

### Creates a new datasource.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/data-sources-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| body | object | yes | JSON request body |

### Retrieves a datasource definition.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/data-sources-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| dataSourceName | string | yes | The name of the datasource. |

### Creates a new datasource or updates a datasource if it already exists.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/data-sources-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| dataSourceName | string | yes | The name of the datasource. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |
| Prefer | string | yes | For HTTP PUT requests, instructs the service to return the created/updated resource on success. |
| body | object | yes | JSON request body |

### Deletes a datasource.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/data-sources-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| dataSourceName | string | yes | The name of the datasource. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

### Lists all indexers available for a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/indexers-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| $select | array | no | Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The… |
| search | string | no | A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no… |
| pageSize | integer | no | The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default. |
| searchType | string | no | Specifies how the search parameter is interpreted. Currently only 'prefix' is supported. |

### Creates a new indexer.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/indexers-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| body | object | yes | JSON request body |

### Retrieves an indexer definition.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/indexers-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexerName | string | yes | The name of the indexer. |

### Creates a new indexer or updates an indexer if it already exists.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/indexers-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexerName | string | yes | The name of the indexer. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |
| Prefer | string | yes | For HTTP PUT requests, instructs the service to return the created/updated resource on success. |
| body | object | yes | JSON request body |

### Deletes an indexer.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/indexers-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexerName | string | yes | The name of the indexer. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

### Resets the change tracking state associated with an indexer.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/indexers-reset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexerName | string | yes | The name of the indexer. |

### Resync selective options from the datasource to be re-ingested by the indexer."
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/indexers-resync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexerName | string | yes | The name of the indexer. |
| body | object | yes | JSON request body |

### Runs an indexer on-demand.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/indexers-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexerName | string | yes | The name of the indexer. |

### Returns the current status and execution history of an indexer.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/indexers-get-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexerName | string | yes | The name of the indexer. |

### Lists all indexes available for a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/indexes-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| search | string | no | A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no… |
| pageSize | integer | no | The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default. |
| searchType | string | no | Specifies how the search parameter is interpreted. Currently only 'prefix' is supported. |

### Creates a new search index.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/indexes-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| body | object | yes | JSON request body |

### Retrieves an index definition.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/indexes-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |

### Creates a new search index or updates an index if it already exists.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/indexes-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |
| allowIndexDowntime | boolean | no | Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few… |
| Prefer | string | yes | For HTTP PUT requests, instructs the service to return the created/updated resource on success. |
| body | object | yes | JSON request body |

### Deletes a search index and all the documents it contains. This operation is permanent, with no recovery…
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/indexes-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

### Searches for documents in the index.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/documents-search-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| x-ms-query-source-authorization | string | no | Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. |
| x-ms-enable-elevated-read | boolean | no | A value that enables elevated read that bypass document level permission checks for the query operation. |
| search | string | no | A full-text search query expression; Use "*" or omit this parameter to match all documents. |
| $count | boolean | no | A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance… |
| facet | array | no | The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a… |
| $filter | string | no | The OData $filter expression to apply to the search query. |
| highlight | array | no | The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. |
| highlightPostTag | string | no | A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. |
| highlightPreTag | string | no | A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. |
| minimumCoverage | number | no | A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be… |
| moreLikeThis | string | no | The key of the document to use as the basis for finding similar documents. This parameter cannot be used together with search text. |
| $orderby | array | no | The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the… |
| queryType | string | no | A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. |
| scoringParameter | array | no | The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For… |
| scoringProfile | string | no | The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. |
| searchFields | array | no | The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene… |
| searchMode | string | no | A value that specifies whether any or all of the search terms must be matched in order to count the document as a match. |
| scoringStatistics | string | no | A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring,… |
| sessionId | string | no | A value to be used to create a sticky session, which can help to get more consistent results. As long as the same sessionId is used, a… |
| $select | array | no | The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. |
| $skip | integer | no | The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use… |
| $top | integer | no | The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If… |
| semanticConfiguration | string | no | The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers |
| semanticErrorHandling | string | no | Allows the user to choose whether a semantic call should fail completely, or to return partial results (default). |
| semanticMaxWaitInMilliseconds | integer | no | Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails. |
| answers | string | no | This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest… |
| captions | string | no | This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the… |
| semanticQuery | string | no | Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful… |
| debug | string | no | Enables a debugging tool that can be used to further explore your search results. |

### Queries the number of documents in the index.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/documents-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |

### Autocompletes incomplete query terms based on input text and matching terms in the index.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/documents-autocomplete-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| search | string | yes | The incomplete term which should be auto-completed. |
| suggesterName | string | yes | The name of the suggester as specified in the suggesters collection that's part of the index definition. |
| autocompleteMode | string | no | Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current… |
| $filter | string | no | An OData expression that filters the documents used to produce completed terms for the Autocomplete result. |
| fuzzy | boolean | no | A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms… |
| highlightPostTag | string | no | A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled. |
| highlightPreTag | string | no | A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled. |
| minimumCoverage | number | no | A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to… |
| searchFields | array | no | The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester. |
| $top | integer | no | The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5. |

### Sends a batch of document write actions to the index.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/documents-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| body | object | yes | JSON request body |

### Autocompletes incomplete query terms based on input text and matching terms in the index.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/documents-autocomplete-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| body | object | yes | JSON request body |

### Searches for documents in the index.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/documents-search-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| x-ms-query-source-authorization | string | no | Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. |
| x-ms-enable-elevated-read | boolean | no | A value that enables elevated read that bypass document level permission checks for the query operation. |
| body | object | yes | JSON request body |

### Suggests documents in the index that match the given partial query text.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/documents-suggest-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| body | object | yes | JSON request body |

### Suggests documents in the index that match the given partial query text.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/documents-suggest-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| search | string | yes | The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters. |
| suggesterName | string | yes | The name of the suggester as specified in the suggesters collection that's part of the index definition. |
| $filter | string | no | An OData expression that filters the documents considered for suggestions. |
| fuzzy | boolean | no | A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms… |
| highlightPostTag | string | no | A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled. |
| highlightPreTag | string | no | A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is… |
| minimumCoverage | number | no | A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be… |
| $orderby | array | no | The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the… |
| searchFields | array | no | The list of field names to search for the specified search text. Target fields must be included in the specified suggester. |
| $select | array | no | The list of fields to retrieve. If unspecified, only the key field will be included in the results. |
| $top | integer | no | The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5. |

### Retrieves a document from the index.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/documents-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| x-ms-query-source-authorization | string | no | Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. |
| x-ms-enable-elevated-read | boolean | no | A value that enables elevated read that bypass document level permission checks for the query operation. |
| key | string | yes | The key of the document to retrieve. |
| $select | array | no | List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document. |

### Shows how an analyzer breaks text into tokens.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/indexes-analyze` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |
| body | object | yes | JSON request body |

### Returns statistics for the given index, including a document count and storage usage.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/indexes-get-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| indexName | string | yes | The name of the index. |

### Retrieves a summary of statistics for all indexes in the search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/get-index-stats-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| search | string | no | A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no… |
| pageSize | integer | no | The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default. |
| searchType | string | no | Specifies how the search parameter is interpreted. Currently only 'prefix' is supported. |

### Lists all knowledge bases available for a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-bases-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| search | string | no | A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no… |
| pageSize | integer | no | The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default. |
| searchType | string | no | Specifies how the search parameter is interpreted. Currently only 'prefix' is supported. |

### Creates a new knowledge base.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-bases-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| body | object | yes | JSON request body |

### Retrieves a knowledge base definition.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-bases-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| knowledgeBaseName | string | yes | The name of the knowledge base. |

### Creates a new knowledge base or updates a knowledge base if it already exists.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-bases-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| knowledgeBaseName | string | yes | The name of the knowledge base. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |
| Prefer | string | yes | For HTTP PUT requests, instructs the service to return the created/updated resource on success. |
| body | object | yes | JSON request body |

### Deletes a knowledge base.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-bases-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| knowledgeBaseName | string | yes | The name of the knowledge base. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

### KnowledgeBase retrieves relevant data from backing stores.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-retrieval-retrieve` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| knowledgeBaseName | string | yes | The name of the knowledge base. |
| x-ms-query-source-authorization | string | no | Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| body | object | yes | JSON request body |

### Lists all knowledge sources available for a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-sources-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| search | string | no | A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no… |
| pageSize | integer | no | The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default. |
| searchType | string | no | Specifies how the search parameter is interpreted. Currently only 'prefix' is supported. |

### Creates a new knowledge source.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-sources-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| body | object | yes | JSON request body |

### Retrieves a knowledge source definition.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-sources-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| sourceName | string | yes | The name of the knowledge source. |

### Creates a new knowledge source or updates an knowledge source if it already exists.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-sources-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| sourceName | string | yes | The name of the knowledge source. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |
| Prefer | string | yes | For HTTP PUT requests, instructs the service to return the created/updated resource on success. |
| body | object | yes | JSON request body |

### Deletes an existing knowledge source.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-sources-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| sourceName | string | yes | The name of the knowledge source. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

### Lists all files in a File knowledge source.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-sources-list-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| sourceName | string | yes | The name of the knowledge source. |
| prefix | string | no | Optional prefix to filter files by their directory-like path. |
| search | string | no | A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no… |
| pageSize | integer | no | The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default. |
| searchType | string | no | Specifies how the search parameter is interpreted. Currently only 'prefix' is supported. |

### Uploads a file to a File knowledge source using multipart/form-data: a JSON 'metadata' part (file name and…
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-sources-upload-file-multipart` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| sourceName | string | yes | The name of the knowledge source. |
| body | object | yes | Form fields as a JSON object |

### Updates an existing file in a File knowledge source in place, replacing its indexed content. Uses…
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-sources-update-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| sourceName | string | yes | The name of the knowledge source. |
| fileId | string | yes | The unique identifier of the file to update. |
| body | object | yes | Form fields as a JSON object |

### Deletes a file from a File knowledge source and removes all indexed content derived from it.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-sources-delete-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| sourceName | string | yes | The name of the knowledge source. |
| fileId | string | yes | The unique identifier of the file to delete. |

### Retrieves the status of a knowledge source.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/knowledge-sources-get-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| sourceName | string | yes | The name of the knowledge source. |

### Gets service level statistics for a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/get-service-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |

### List all skillsets in a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/skillsets-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| $select | array | no | Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The… |
| search | string | no | A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no… |
| pageSize | integer | no | The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default. |
| searchType | string | no | Specifies how the search parameter is interpreted. Currently only 'prefix' is supported. |

### Creates a new skillset in a search service.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/skillsets-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| body | object | yes | JSON request body |

### Retrieves a skillset in a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/skillsets-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| skillsetName | string | yes | The name of the skillset. |

### Creates a new skillset in a search service or updates the skillset if it already exists.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/skillsets-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| skillsetName | string | yes | The name of the skillset. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |
| Prefer | string | yes | For HTTP PUT requests, instructs the service to return the created/updated resource on success. |
| body | object | yes | JSON request body |

### Deletes a skillset in a search service.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/skillsets-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| skillsetName | string | yes | The name of the skillset. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

### Lists all synonym maps available for a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/synonym-maps-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| $select | array | no | Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The… |
| search | string | no | A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no… |
| pageSize | integer | no | The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default. |
| searchType | string | no | Specifies how the search parameter is interpreted. Currently only 'prefix' is supported. |

### Creates a new synonym map.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/synonym-maps-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| body | object | yes | JSON request body |

### Retrieves a synonym map definition.
`GET https://zieapi.vercel.app/v1/cloud:azure-search-search/synonym-maps-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| synonymMapName | string | yes | The name of the synonym map. |

### Creates a new synonym map or updates a synonym map if it already exists.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/synonym-maps-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| synonymMapName | string | yes | The name of the synonym map. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |
| Prefer | string | yes | For HTTP PUT requests, instructs the service to return the created/updated resource on success. |
| body | object | yes | JSON request body |

### Deletes a synonym map.
`POST https://zieapi.vercel.app/v1/cloud:azure-search-search/synonym-maps-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The endpoint URL of the search service. |
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| synonymMapName | string | yes | The name of the synonym map. |
| If-Match | string | no | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. |
| If-None-Match | string | no | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-search-search/aliases-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure AI Search API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:azure-search-search/aliases-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure AI Search API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure AI Search itself also needs your own key from azure.com.

### Can AI agents use the Azure AI Search API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-search-search.

### What is the status of the Azure AI Search API?
Needs your own provider key (bring your own key)