{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:amazonaws-cloudsearchdomain/search":{"get":{"operationId":"cloud_amazonaws_cloudsearchdomain_search","summary":"Retrieves a list of documents that match the specified search criteria. How you specify the search criteria…","description":"GET /2013-01-01/search","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"cursor","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"expr","in":"query","required":false,"description":"Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify…","schema":{"type":"string","description":"Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify…"}},{"name":"facet","in":"query","required":false,"description":"Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each…","schema":{"type":"string","description":"Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each…"}},{"name":"fq","in":"query","required":false,"description":"Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use…","schema":{"type":"string","description":"Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use…"}},{"name":"highlight","in":"query","required":false,"description":"Retrieves highlights for matches in the specified text or text-array fields. Each specified field must be highlight enabled in the domain…","schema":{"type":"string","description":"Retrieves highlights for matches in the specified text or text-array fields. Each specified field must be highlight enabled in the domain…"}},{"name":"partial","in":"query","required":false,"description":"Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across…","schema":{"type":"boolean","description":"Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across…"}},{"name":"q","in":"query","required":true,"description":"Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and…","schema":{"type":"string","description":"Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and…"}},{"name":"q.options","in":"query","required":false,"description":"Configures options for the query parser specified in the queryParser parameter. You specify the options in JSON using the following form…","schema":{"type":"string","description":"Configures options for the query parser specified in the queryParser parameter. You specify the options in JSON using the following form…"}},{"name":"q.parser","in":"query","required":false,"description":"Specifies which query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch uses the simple query…","schema":{"type":"string","enum":["simple","structured","lucene","dismax"],"description":"Specifies which query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch uses the simple query…"}},{"name":"return","in":"query","required":false,"description":"Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated…","schema":{"type":"string","description":"Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated…"}},{"name":"size","in":"query","required":false,"description":"Specifies the maximum number of search hits to include in the response.","schema":{"type":"integer","description":"Specifies the maximum number of search hits to include in the response."}},{"name":"sort","in":"query","required":false,"description":"Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a…","schema":{"type":"string","description":"Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a…"}},{"name":"start","in":"query","required":false,"description":"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.…","schema":{"type":"integer","description":"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.…"}},{"name":"stats","in":"query","required":false,"description":"Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain…","schema":{"type":"string","description":"Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain…"}},{"name":"format","in":"query","required":true,"schema":{"type":"string","enum":["sdk"]}},{"name":"pretty","in":"query","required":true,"schema":{"type":"string","enum":["true"]}}],"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:amazonaws-cloudsearchdomain/suggest":{"get":{"operationId":"cloud_amazonaws_cloudsearchdomain_suggest","summary":"Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display…","description":"GET /2013-01-01/suggest","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"q","in":"query","required":true,"description":"Specifies the string for which you want to get suggestions.","schema":{"type":"string","description":"Specifies the string for which you want to get suggestions."}},{"name":"suggester","in":"query","required":true,"description":"Specifies the name of the suggester to use to find suggested matches.","schema":{"type":"string","description":"Specifies the name of the suggester to use to find suggested matches."}},{"name":"size","in":"query","required":false,"description":"Specifies the maximum number of suggestions to return.","schema":{"type":"integer","description":"Specifies the maximum number of suggestions to return."}},{"name":"format","in":"query","required":true,"schema":{"type":"string","enum":["sdk"]}},{"name":"pretty","in":"query","required":true,"schema":{"type":"string","enum":["true"]}}],"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:amazonaws-cloudsearchdomain/upload-documents":{"post":{"operationId":"cloud_amazonaws_cloudsearchdomain_upload_documents","summary":"Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and…","description":"POST /2013-01-01/documents/batch","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["format","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"format":{"type":"string","enum":["sdk"]},"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"}}},"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"}}}}}}}