# Amazon CloudSearch Domain API

> Amazon CloudSearch Domain API on Apizie: 3 endpoints (Retrieves a list of documents that match the specified search criteria. How you specify the search criteria…, Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display…, Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and…) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:amazonaws-cloudsearchdomain/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-cloudsearchdomain`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://www.apizie.tech/api/cloud/amazonaws-cloudsearchdomain
- OpenAPI: https://www.apizie.tech/api/cloud/amazonaws-cloudsearchdomain/openapi.json

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. The endpoints for submitting UploadDocuments , Search , and Suggest requests are domain-specific. To get the…

## Endpoints

### Retrieves a list of documents that match the specified search criteria. How you specify the search criteria…
`GET https://www.apizie.tech/v1/cloud:amazonaws-cloudsearchdomain/search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| cursor | string | no | Retrieves a cursor value you can use to page through large result sets. Use the size parameter to control the number of hits to include in… |
| expr | string | no | Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify… |
| facet | string | no | Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each… |
| fq | string | no | Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use… |
| highlight | string | no | Retrieves highlights for matches in the specified text or text-array fields. Each specified field must be highlight enabled in the domain… |
| partial | boolean | no | Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across… |
| q | string | yes | Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and… |
| q.options | string | no | Configures options for the query parser specified in the queryParser parameter. You specify the options in JSON using the following form… |
| q.parser | string | no | Specifies which query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch uses the simple query… |
| return | string | no | Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated… |
| size | integer | no | Specifies the maximum number of search hits to include in the response. |
| sort | string | no | Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a… |
| start | integer | no | Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0.… |
| stats | string | no | Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain… |
| format | string | yes |  |
| pretty | string | yes |  |

### Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display…
`GET https://www.apizie.tech/v1/cloud:amazonaws-cloudsearchdomain/suggest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| q | string | yes | Specifies the string for which you want to get suggestions. |
| suggester | string | yes | Specifies the name of the suggester to use to find suggested matches. |
| size | integer | no | Specifies the maximum number of suggestions to return. |
| format | string | yes |  |
| pretty | string | yes |  |

### Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and…
`POST https://www.apizie.tech/v1/cloud:amazonaws-cloudsearchdomain/upload-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| format | string | yes |  |
| body | object | yes | JSON request body |

## Example
```
curl "https://www.apizie.tech/v1/cloud:amazonaws-cloudsearchdomain/search" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon CloudSearch Domain API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/cloud:amazonaws-cloudsearchdomain/search with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Amazon CloudSearch Domain API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-cloudsearchdomain.

### What is the status of the Amazon CloudSearch Domain API?
Needs your own provider key (bring your own key)