{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:azure-search-search/aliases-list":{"get":{"operationId":"cloud_azure_search_search_aliases_list","summary":"Lists all aliases available for a search service.","description":"GET /aliases","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"search","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.","schema":{"type":"integer","description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default."}},{"name":"searchType","in":"query","required":false,"description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.","schema":{"type":"string","enum":["prefix"],"default":"prefix","description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/aliases-create":{"post":{"operationId":"cloud_azure_search_search_aliases_create","summary":"Creates a new search alias.","description":"POST /aliases","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/aliases-get":{"get":{"operationId":"cloud_azure_search_search_aliases_get","summary":"Retrieves an alias definition.","description":"GET /aliases('{aliasName}')","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"aliasName","in":"query","required":true,"description":"The name of the alias.","schema":{"type":"string","description":"The name of the alias."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/aliases-create-or-update":{"post":{"operationId":"cloud_azure_search_search_aliases_create_or_update","summary":"Creates a new search alias or updates an alias if it already exists.","description":"PUT /aliases('{aliasName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","aliasName","Prefer","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"aliasName":{"type":"string","description":"The name of the alias."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."},"Prefer":{"type":"string","enum":["return=representation"],"description":"For HTTP PUT requests, instructs the service to return the created/updated resource on success."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/aliases-delete":{"post":{"operationId":"cloud_azure_search_search_aliases_delete","summary":"Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery…","description":"DELETE /aliases('{aliasName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","aliasName"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"aliasName":{"type":"string","description":"The name of the alias."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/data-sources-list":{"get":{"operationId":"cloud_azure_search_search_data_sources_list","summary":"Lists all datasources available for a search service.","description":"GET /datasources","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"$select","in":"query","required":false,"description":"Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The…","schema":{"type":"array","description":"Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The…"}},{"name":"search","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.","schema":{"type":"integer","description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default."}},{"name":"searchType","in":"query","required":false,"description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.","schema":{"type":"string","enum":["prefix"],"default":"prefix","description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/data-sources-create":{"post":{"operationId":"cloud_azure_search_search_data_sources_create","summary":"Creates a new datasource.","description":"POST /datasources","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/data-sources-get":{"get":{"operationId":"cloud_azure_search_search_data_sources_get","summary":"Retrieves a datasource definition.","description":"GET /datasources('{dataSourceName}')","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"dataSourceName","in":"query","required":true,"description":"The name of the datasource.","schema":{"type":"string","description":"The name of the datasource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/data-sources-create-or-update":{"post":{"operationId":"cloud_azure_search_search_data_sources_create_or_update","summary":"Creates a new datasource or updates a datasource if it already exists.","description":"PUT /datasources('{dataSourceName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","dataSourceName","Prefer","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"dataSourceName":{"type":"string","description":"The name of the datasource."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."},"Prefer":{"type":"string","enum":["return=representation"],"description":"For HTTP PUT requests, instructs the service to return the created/updated resource on success."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/data-sources-delete":{"post":{"operationId":"cloud_azure_search_search_data_sources_delete","summary":"Deletes a datasource.","description":"DELETE /datasources('{dataSourceName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","dataSourceName"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"dataSourceName":{"type":"string","description":"The name of the datasource."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexers-list":{"get":{"operationId":"cloud_azure_search_search_indexers_list","summary":"Lists all indexers available for a search service.","description":"GET /indexers","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"$select","in":"query","required":false,"description":"Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The…","schema":{"type":"array","description":"Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The…"}},{"name":"search","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.","schema":{"type":"integer","description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default."}},{"name":"searchType","in":"query","required":false,"description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.","schema":{"type":"string","enum":["prefix"],"default":"prefix","description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexers-create":{"post":{"operationId":"cloud_azure_search_search_indexers_create","summary":"Creates a new indexer.","description":"POST /indexers","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexers-get":{"get":{"operationId":"cloud_azure_search_search_indexers_get","summary":"Retrieves an indexer definition.","description":"GET /indexers('{indexerName}')","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"indexerName","in":"query","required":true,"description":"The name of the indexer.","schema":{"type":"string","description":"The name of the indexer."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexers-create-or-update":{"post":{"operationId":"cloud_azure_search_search_indexers_create_or_update","summary":"Creates a new indexer or updates an indexer if it already exists.","description":"PUT /indexers('{indexerName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexerName","Prefer","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexerName":{"type":"string","description":"The name of the indexer."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."},"Prefer":{"type":"string","enum":["return=representation"],"description":"For HTTP PUT requests, instructs the service to return the created/updated resource on success."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexers-delete":{"post":{"operationId":"cloud_azure_search_search_indexers_delete","summary":"Deletes an indexer.","description":"DELETE /indexers('{indexerName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexerName"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexerName":{"type":"string","description":"The name of the indexer."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexers-reset":{"post":{"operationId":"cloud_azure_search_search_indexers_reset","summary":"Resets the change tracking state associated with an indexer.","description":"POST /indexers('{indexerName}')/search.reset","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexerName"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexerName":{"type":"string","description":"The name of the indexer."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexers-resync":{"post":{"operationId":"cloud_azure_search_search_indexers_resync","summary":"Resync selective options from the datasource to be re-ingested by the indexer.\"","description":"POST /indexers('{indexerName}')/search.resync","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexerName","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexerName":{"type":"string","description":"The name of the indexer."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexers-run":{"post":{"operationId":"cloud_azure_search_search_indexers_run","summary":"Runs an indexer on-demand.","description":"POST /indexers('{indexerName}')/search.run","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexerName"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexerName":{"type":"string","description":"The name of the indexer."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexers-get-status":{"get":{"operationId":"cloud_azure_search_search_indexers_get_status","summary":"Returns the current status and execution history of an indexer.","description":"GET /indexers('{indexerName}')/search.status","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"indexerName","in":"query","required":true,"description":"The name of the indexer.","schema":{"type":"string","description":"The name of the indexer."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexes-list":{"get":{"operationId":"cloud_azure_search_search_indexes_list","summary":"Lists all indexes available for a search service.","description":"GET /indexes","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"search","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.","schema":{"type":"integer","description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default."}},{"name":"searchType","in":"query","required":false,"description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.","schema":{"type":"string","enum":["prefix"],"default":"prefix","description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexes-create":{"post":{"operationId":"cloud_azure_search_search_indexes_create","summary":"Creates a new search index.","description":"POST /indexes","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexes-get":{"get":{"operationId":"cloud_azure_search_search_indexes_get","summary":"Retrieves an index definition.","description":"GET /indexes('{indexName}')","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"indexName","in":"query","required":true,"description":"The name of the index.","schema":{"type":"string","description":"The name of the index."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexes-create-or-update":{"post":{"operationId":"cloud_azure_search_search_indexes_create_or_update","summary":"Creates a new search index or updates an index if it already exists.","description":"PUT /indexes('{indexName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexName","Prefer","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexName":{"type":"string","description":"The name of the index."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."},"allowIndexDowntime":{"type":"boolean","description":"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":{"type":"string","enum":["return=representation"],"description":"For HTTP PUT requests, instructs the service to return the created/updated resource on success."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexes-delete":{"post":{"operationId":"cloud_azure_search_search_indexes_delete","summary":"Deletes a search index and all the documents it contains. This operation is permanent, with no recovery…","description":"DELETE /indexes('{indexName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexName"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexName":{"type":"string","description":"The name of the index."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/documents-search-get":{"get":{"operationId":"cloud_azure_search_search_documents_search_get","summary":"Searches for documents in the index.","description":"GET /indexes('{indexName}')/docs","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"indexName","in":"query","required":true,"description":"The name of the index.","schema":{"type":"string","description":"The name of the index."}},{"name":"x-ms-query-source-authorization","in":"query","required":false,"description":"Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents.","schema":{"type":"string","description":"Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents."}},{"name":"x-ms-enable-elevated-read","in":"query","required":false,"description":"A value that enables elevated read that bypass document level permission checks for the query operation.","schema":{"type":"boolean","description":"A value that enables elevated read that bypass document level permission checks for the query operation."}},{"name":"search","in":"query","required":false,"description":"A full-text search query expression; Use \"*\" or omit this parameter to match all documents.","schema":{"type":"string","description":"A full-text search query expression; Use \"*\" or omit this parameter to match all documents."}},{"name":"$count","in":"query","required":false,"description":"A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance…","schema":{"type":"boolean","description":"A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance…"}},{"name":"facet","in":"query","required":false,"description":"The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a…","schema":{"type":"array","description":"The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a…"}},{"name":"$filter","in":"query","required":false,"description":"The OData $filter expression to apply to the search query.","schema":{"type":"string","description":"The OData $filter expression to apply to the search query."}},{"name":"highlight","in":"query","required":false,"description":"The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.","schema":{"type":"array","description":"The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting."}},{"name":"highlightPostTag","in":"query","required":false,"description":"A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.","schema":{"type":"string","description":"A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>."}},{"name":"highlightPreTag","in":"query","required":false,"description":"A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.","schema":{"type":"string","description":"A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>."}},{"name":"minimumCoverage","in":"query","required":false,"description":"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…","schema":{"type":"number","description":"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…"}},{"name":"moreLikeThis","in":"query","required":false,"description":"The key of the document to use as the basis for finding similar documents. This parameter cannot be used together with search text.","schema":{"type":"string","description":"The key of the document to use as the basis for finding similar documents. This parameter cannot be used together with search text."}},{"name":"$orderby","in":"query","required":false,"description":"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…","schema":{"type":"array","description":"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…"}},{"name":"queryType","in":"query","required":false,"description":"A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.","schema":{"type":"string","enum":["simple","full","semantic"],"description":"A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax."}},{"name":"scoringParameter","in":"query","required":false,"description":"The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For…","schema":{"type":"array","description":"The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For…"}},{"name":"scoringProfile","in":"query","required":false,"description":"The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.","schema":{"type":"string","description":"The name of a scoring profile to evaluate match scores for matching documents in order to sort the results."}},{"name":"searchFields","in":"query","required":false,"description":"The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene…","schema":{"type":"array","description":"The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene…"}},{"name":"searchMode","in":"query","required":false,"description":"A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.","schema":{"type":"string","enum":["any","all"],"description":"A value that specifies whether any or all of the search terms must be matched in order to count the document as a match."}},{"name":"scoringStatistics","in":"query","required":false,"description":"A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring,…","schema":{"type":"string","enum":["local","global"],"description":"A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring,…"}},{"name":"sessionId","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"$select","in":"query","required":false,"description":"The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.","schema":{"type":"array","description":"The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included."}},{"name":"$skip","in":"query","required":false,"description":"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…","schema":{"type":"integer","description":"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…"}},{"name":"$top","in":"query","required":false,"description":"The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If…","schema":{"type":"integer","description":"The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If…"}},{"name":"semanticConfiguration","in":"query","required":false,"description":"The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers","schema":{"type":"string","description":"The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers"}},{"name":"semanticErrorHandling","in":"query","required":false,"description":"Allows the user to choose whether a semantic call should fail completely, or to return partial results (default).","schema":{"type":"string","enum":["partial","fail"],"description":"Allows the user to choose whether a semantic call should fail completely, or to return partial results (default)."}},{"name":"semanticMaxWaitInMilliseconds","in":"query","required":false,"description":"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.","schema":{"type":"integer","description":"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."}},{"name":"answers","in":"query","required":false,"description":"This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest…","schema":{"type":"string","enum":["none","extractive"],"description":"This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest…"}},{"name":"captions","in":"query","required":false,"description":"This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the…","schema":{"type":"string","enum":["none","extractive"],"description":"This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the…"}},{"name":"semanticQuery","in":"query","required":false,"description":"Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful…","schema":{"type":"string","description":"Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful…"}},{"name":"debug","in":"query","required":false,"description":"Enables a debugging tool that can be used to further explore your search results.","schema":{"type":"string","enum":["disabled","semantic","vector","queryRewrites","innerHits","all"],"description":"Enables a debugging tool that can be used to further explore your search results."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/documents-count":{"get":{"operationId":"cloud_azure_search_search_documents_count","summary":"Queries the number of documents in the index.","description":"GET /indexes('{indexName}')/docs/$count","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"indexName","in":"query","required":true,"description":"The name of the index.","schema":{"type":"string","description":"The name of the index."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/documents-autocomplete-get":{"get":{"operationId":"cloud_azure_search_search_documents_autocomplete_get","summary":"Autocompletes incomplete query terms based on input text and matching terms in the index.","description":"GET /indexes('{indexName}')/docs/search.autocomplete","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"indexName","in":"query","required":true,"description":"The name of the index.","schema":{"type":"string","description":"The name of the index."}},{"name":"search","in":"query","required":true,"description":"The incomplete term which should be auto-completed.","schema":{"type":"string","description":"The incomplete term which should be auto-completed."}},{"name":"suggesterName","in":"query","required":true,"description":"The name of the suggester as specified in the suggesters collection that's part of the index definition.","schema":{"type":"string","description":"The name of the suggester as specified in the suggesters collection that's part of the index definition."}},{"name":"autocompleteMode","in":"query","required":false,"description":"Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current…","schema":{"type":"string","enum":["oneTerm","twoTerms","oneTermWithContext"],"description":"Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current…"}},{"name":"$filter","in":"query","required":false,"description":"An OData expression that filters the documents used to produce completed terms for the Autocomplete result.","schema":{"type":"string","description":"An OData expression that filters the documents used to produce completed terms for the Autocomplete result."}},{"name":"fuzzy","in":"query","required":false,"description":"A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms…","schema":{"type":"boolean","description":"A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms…"}},{"name":"highlightPostTag","in":"query","required":false,"description":"A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.","schema":{"type":"string","description":"A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled."}},{"name":"highlightPreTag","in":"query","required":false,"description":"A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.","schema":{"type":"string","description":"A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled."}},{"name":"minimumCoverage","in":"query","required":false,"description":"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…","schema":{"type":"number","description":"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…"}},{"name":"searchFields","in":"query","required":false,"description":"The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.","schema":{"type":"array","description":"The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester."}},{"name":"$top","in":"query","required":false,"description":"The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.","schema":{"type":"integer","description":"The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/documents-index":{"post":{"operationId":"cloud_azure_search_search_documents_index","summary":"Sends a batch of document write actions to the index.","description":"POST /indexes('{indexName}')/docs/search.index","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexName","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexName":{"type":"string","description":"The name of the index."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/documents-autocomplete-post":{"post":{"operationId":"cloud_azure_search_search_documents_autocomplete_post","summary":"Autocompletes incomplete query terms based on input text and matching terms in the index.","description":"POST /indexes('{indexName}')/docs/search.post.autocomplete","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexName","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexName":{"type":"string","description":"The name of the index."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/documents-search-post":{"post":{"operationId":"cloud_azure_search_search_documents_search_post","summary":"Searches for documents in the index.","description":"POST /indexes('{indexName}')/docs/search.post.search","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexName","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexName":{"type":"string","description":"The name of the index."},"x-ms-query-source-authorization":{"type":"string","description":"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":{"type":"boolean","description":"A value that enables elevated read that bypass document level permission checks for the query operation."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/documents-suggest-post":{"post":{"operationId":"cloud_azure_search_search_documents_suggest_post","summary":"Suggests documents in the index that match the given partial query text.","description":"POST /indexes('{indexName}')/docs/search.post.suggest","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexName","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexName":{"type":"string","description":"The name of the index."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/documents-suggest-get":{"get":{"operationId":"cloud_azure_search_search_documents_suggest_get","summary":"Suggests documents in the index that match the given partial query text.","description":"GET /indexes('{indexName}')/docs/search.suggest","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"indexName","in":"query","required":true,"description":"The name of the index.","schema":{"type":"string","description":"The name of the index."}},{"name":"search","in":"query","required":true,"description":"The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.","schema":{"type":"string","description":"The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters."}},{"name":"suggesterName","in":"query","required":true,"description":"The name of the suggester as specified in the suggesters collection that's part of the index definition.","schema":{"type":"string","description":"The name of the suggester as specified in the suggesters collection that's part of the index definition."}},{"name":"$filter","in":"query","required":false,"description":"An OData expression that filters the documents considered for suggestions.","schema":{"type":"string","description":"An OData expression that filters the documents considered for suggestions."}},{"name":"fuzzy","in":"query","required":false,"description":"A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms…","schema":{"type":"boolean","description":"A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms…"}},{"name":"highlightPostTag","in":"query","required":false,"description":"A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.","schema":{"type":"string","description":"A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled."}},{"name":"highlightPreTag","in":"query","required":false,"description":"A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is…","schema":{"type":"string","description":"A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is…"}},{"name":"minimumCoverage","in":"query","required":false,"description":"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…","schema":{"type":"number","description":"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…"}},{"name":"$orderby","in":"query","required":false,"description":"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…","schema":{"type":"array","description":"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…"}},{"name":"searchFields","in":"query","required":false,"description":"The list of field names to search for the specified search text. Target fields must be included in the specified suggester.","schema":{"type":"array","description":"The list of field names to search for the specified search text. Target fields must be included in the specified suggester."}},{"name":"$select","in":"query","required":false,"description":"The list of fields to retrieve. If unspecified, only the key field will be included in the results.","schema":{"type":"array","description":"The list of fields to retrieve. If unspecified, only the key field will be included in the results."}},{"name":"$top","in":"query","required":false,"description":"The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.","schema":{"type":"integer","description":"The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/documents-get":{"get":{"operationId":"cloud_azure_search_search_documents_get","summary":"Retrieves a document from the index.","description":"GET /indexes('{indexName}')/docs('{key}')","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"indexName","in":"query","required":true,"description":"The name of the index.","schema":{"type":"string","description":"The name of the index."}},{"name":"x-ms-query-source-authorization","in":"query","required":false,"description":"Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents.","schema":{"type":"string","description":"Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents."}},{"name":"x-ms-enable-elevated-read","in":"query","required":false,"description":"A value that enables elevated read that bypass document level permission checks for the query operation.","schema":{"type":"boolean","description":"A value that enables elevated read that bypass document level permission checks for the query operation."}},{"name":"key","in":"query","required":true,"description":"The key of the document to retrieve.","schema":{"type":"string","description":"The key of the document to retrieve."}},{"name":"$select","in":"query","required":false,"description":"List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.","schema":{"type":"array","description":"List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexes-analyze":{"post":{"operationId":"cloud_azure_search_search_indexes_analyze","summary":"Shows how an analyzer breaks text into tokens.","description":"POST /indexes('{indexName}')/search.analyze","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","indexName","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"indexName":{"type":"string","description":"The name of the index."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/indexes-get-statistics":{"get":{"operationId":"cloud_azure_search_search_indexes_get_statistics","summary":"Returns statistics for the given index, including a document count and storage usage.","description":"GET /indexes('{indexName}')/search.stats","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"indexName","in":"query","required":true,"description":"The name of the index.","schema":{"type":"string","description":"The name of the index."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/get-index-stats-summary":{"get":{"operationId":"cloud_azure_search_search_get_index_stats_summary","summary":"Retrieves a summary of statistics for all indexes in the search service.","description":"GET /indexstats","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"search","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.","schema":{"type":"integer","description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default."}},{"name":"searchType","in":"query","required":false,"description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.","schema":{"type":"string","enum":["prefix"],"default":"prefix","description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-bases-list":{"get":{"operationId":"cloud_azure_search_search_knowledge_bases_list","summary":"Lists all knowledge bases available for a search service.","description":"GET /knowledgebases","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"search","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.","schema":{"type":"integer","description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default."}},{"name":"searchType","in":"query","required":false,"description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.","schema":{"type":"string","enum":["prefix"],"default":"prefix","description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-bases-create":{"post":{"operationId":"cloud_azure_search_search_knowledge_bases_create","summary":"Creates a new knowledge base.","description":"POST /knowledgebases","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-bases-get":{"get":{"operationId":"cloud_azure_search_search_knowledge_bases_get","summary":"Retrieves a knowledge base definition.","description":"GET /knowledgebases('{knowledgeBaseName}')","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"knowledgeBaseName","in":"query","required":true,"description":"The name of the knowledge base.","schema":{"type":"string","description":"The name of the knowledge base."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-bases-create-or-update":{"post":{"operationId":"cloud_azure_search_search_knowledge_bases_create_or_update","summary":"Creates a new knowledge base or updates a knowledge base if it already exists.","description":"PUT /knowledgebases('{knowledgeBaseName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","knowledgeBaseName","Prefer","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"knowledgeBaseName":{"type":"string","description":"The name of the knowledge base."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."},"Prefer":{"type":"string","enum":["return=representation"],"description":"For HTTP PUT requests, instructs the service to return the created/updated resource on success."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-bases-delete":{"post":{"operationId":"cloud_azure_search_search_knowledge_bases_delete","summary":"Deletes a knowledge base.","description":"DELETE /knowledgebases('{knowledgeBaseName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","knowledgeBaseName"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"knowledgeBaseName":{"type":"string","description":"The name of the knowledge base."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-retrieval-retrieve":{"post":{"operationId":"cloud_azure_search_search_knowledge_retrieval_retrieve","summary":"KnowledgeBase retrieves relevant data from backing stores.","description":"POST /knowledgebases('{knowledgeBaseName}')/retrieve","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","knowledgeBaseName","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"knowledgeBaseName":{"type":"string","description":"The name of the knowledge base."},"x-ms-query-source-authorization":{"type":"string","description":"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":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-sources-list":{"get":{"operationId":"cloud_azure_search_search_knowledge_sources_list","summary":"Lists all knowledge sources available for a search service.","description":"GET /knowledgesources","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"search","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.","schema":{"type":"integer","description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default."}},{"name":"searchType","in":"query","required":false,"description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.","schema":{"type":"string","enum":["prefix"],"default":"prefix","description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-sources-create":{"post":{"operationId":"cloud_azure_search_search_knowledge_sources_create","summary":"Creates a new knowledge source.","description":"POST /knowledgesources","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-sources-get":{"get":{"operationId":"cloud_azure_search_search_knowledge_sources_get","summary":"Retrieves a knowledge source definition.","description":"GET /knowledgesources('{sourceName}')","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"sourceName","in":"query","required":true,"description":"The name of the knowledge source.","schema":{"type":"string","description":"The name of the knowledge source."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-sources-create-or-update":{"post":{"operationId":"cloud_azure_search_search_knowledge_sources_create_or_update","summary":"Creates a new knowledge source or updates an knowledge source if it already exists.","description":"PUT /knowledgesources('{sourceName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","sourceName","Prefer","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"sourceName":{"type":"string","description":"The name of the knowledge source."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."},"Prefer":{"type":"string","enum":["return=representation"],"description":"For HTTP PUT requests, instructs the service to return the created/updated resource on success."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-sources-delete":{"post":{"operationId":"cloud_azure_search_search_knowledge_sources_delete","summary":"Deletes an existing knowledge source.","description":"DELETE /knowledgesources('{sourceName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","sourceName"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"sourceName":{"type":"string","description":"The name of the knowledge source."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-sources-list-files":{"get":{"operationId":"cloud_azure_search_search_knowledge_sources_list_files","summary":"Lists all files in a File knowledge source.","description":"GET /knowledgesources('{sourceName}')/files","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"sourceName","in":"query","required":true,"description":"The name of the knowledge source.","schema":{"type":"string","description":"The name of the knowledge source."}},{"name":"prefix","in":"query","required":false,"description":"Optional prefix to filter files by their directory-like path.","schema":{"type":"string","description":"Optional prefix to filter files by their directory-like path."}},{"name":"search","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.","schema":{"type":"integer","description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default."}},{"name":"searchType","in":"query","required":false,"description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.","schema":{"type":"string","enum":["prefix"],"default":"prefix","description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-sources-upload-file-multipart":{"post":{"operationId":"cloud_azure_search_search_knowledge_sources_upload_file_multipart","summary":"Uploads a file to a File knowledge source using multipart/form-data: a JSON 'metadata' part (file name and…","description":"POST /knowledgesources('{sourceName}')/files","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","sourceName","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"sourceName":{"type":"string","description":"The name of the knowledge source."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-sources-update-file":{"post":{"operationId":"cloud_azure_search_search_knowledge_sources_update_file","summary":"Updates an existing file in a File knowledge source in place, replacing its indexed content. Uses…","description":"PUT /knowledgesources('{sourceName}')/files('{fileId}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","sourceName","fileId","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"sourceName":{"type":"string","description":"The name of the knowledge source."},"fileId":{"type":"string","description":"The unique identifier of the file to update."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-sources-delete-file":{"post":{"operationId":"cloud_azure_search_search_knowledge_sources_delete_file","summary":"Deletes a file from a File knowledge source and removes all indexed content derived from it.","description":"DELETE /knowledgesources('{sourceName}')/files('{fileId}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","sourceName","fileId"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"sourceName":{"type":"string","description":"The name of the knowledge source."},"fileId":{"type":"string","description":"The unique identifier of the file to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/knowledge-sources-get-status":{"get":{"operationId":"cloud_azure_search_search_knowledge_sources_get_status","summary":"Retrieves the status of a knowledge source.","description":"GET /knowledgesources('{sourceName}')/status","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"sourceName","in":"query","required":true,"description":"The name of the knowledge source.","schema":{"type":"string","description":"The name of the knowledge source."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/get-service-statistics":{"get":{"operationId":"cloud_azure_search_search_get_service_statistics","summary":"Gets service level statistics for a search service.","description":"GET /servicestats","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/skillsets-list":{"get":{"operationId":"cloud_azure_search_search_skillsets_list","summary":"List all skillsets in a search service.","description":"GET /skillsets","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"$select","in":"query","required":false,"description":"Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The…","schema":{"type":"array","description":"Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The…"}},{"name":"search","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.","schema":{"type":"integer","description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default."}},{"name":"searchType","in":"query","required":false,"description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.","schema":{"type":"string","enum":["prefix"],"default":"prefix","description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/skillsets-create":{"post":{"operationId":"cloud_azure_search_search_skillsets_create","summary":"Creates a new skillset in a search service.","description":"POST /skillsets","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/skillsets-get":{"get":{"operationId":"cloud_azure_search_search_skillsets_get","summary":"Retrieves a skillset in a search service.","description":"GET /skillsets('{skillsetName}')","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"skillsetName","in":"query","required":true,"description":"The name of the skillset.","schema":{"type":"string","description":"The name of the skillset."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/skillsets-create-or-update":{"post":{"operationId":"cloud_azure_search_search_skillsets_create_or_update","summary":"Creates a new skillset in a search service or updates the skillset if it already exists.","description":"PUT /skillsets('{skillsetName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","skillsetName","Prefer","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"skillsetName":{"type":"string","description":"The name of the skillset."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."},"Prefer":{"type":"string","enum":["return=representation"],"description":"For HTTP PUT requests, instructs the service to return the created/updated resource on success."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/skillsets-delete":{"post":{"operationId":"cloud_azure_search_search_skillsets_delete","summary":"Deletes a skillset in a search service.","description":"DELETE /skillsets('{skillsetName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","skillsetName"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"skillsetName":{"type":"string","description":"The name of the skillset."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/synonym-maps-list":{"get":{"operationId":"cloud_azure_search_search_synonym_maps_list","summary":"Lists all synonym maps available for a search service.","description":"GET /synonymmaps","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"$select","in":"query","required":false,"description":"Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The…","schema":{"type":"array","description":"Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The…"}},{"name":"search","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.","schema":{"type":"integer","description":"The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default."}},{"name":"searchType","in":"query","required":false,"description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.","schema":{"type":"string","enum":["prefix"],"default":"prefix","description":"Specifies how the search parameter is interpreted. Currently only 'prefix' is supported."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/synonym-maps-create":{"post":{"operationId":"cloud_azure_search_search_synonym_maps_create","summary":"Creates a new synonym map.","description":"POST /synonymmaps","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/synonym-maps-get":{"get":{"operationId":"cloud_azure_search_search_synonym_maps_get","summary":"Retrieves a synonym map definition.","description":"GET /synonymmaps('{synonymMapName}')","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"The endpoint URL of the search service.","schema":{"type":"string","description":"The endpoint URL of the search service."}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-request-id","in":"query","required":false,"description":"An opaque, globally-unique, client-generated string identifier for the request.","schema":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."}},{"name":"synonymMapName","in":"query","required":true,"description":"The name of the synonym map.","schema":{"type":"string","description":"The name of the synonym map."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/synonym-maps-create-or-update":{"post":{"operationId":"cloud_azure_search_search_synonym_maps_create_or_update","summary":"Creates a new synonym map or updates a synonym map if it already exists.","description":"PUT /synonymmaps('{synonymMapName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","synonymMapName","Prefer","body"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"synonymMapName":{"type":"string","description":"The name of the synonym map."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."},"Prefer":{"type":"string","enum":["return=representation"],"description":"For HTTP PUT requests, instructs the service to return the created/updated resource on success."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-search-search/synonym-maps-delete":{"post":{"operationId":"cloud_azure_search_search_synonym_maps_delete","summary":"Deletes a synonym map.","description":"DELETE /synonymmaps('{synonymMapName}')","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","synonymMapName"],"properties":{"endpoint":{"type":"string","description":"The endpoint URL of the search service."},"api-version":{"type":"string","default":"2026-10-01","description":"The API version to use for this operation."},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"synonymMapName":{"type":"string","description":"The name of the synonym map."},"If-Match":{"type":"string","description":"Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value."},"If-None-Match":{"type":"string","description":"Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}