This API exposes
10 operations
across 7 paths,
and defines 25 schemas.
It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
10 operations7 paths25 schemas1 DELETE2 GET6 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Vectorize Beta (Deprecated) API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
Paths & Operations 10
Across 7 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are vectorize_index-query-request (5 properties), vectorize_create-index-response (5 properties), vectorize_api-response-common (4 properties), vectorize_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.
vectorize_index-query-response
object
2 properties
vectorize_index-insert-response
object
2 properties
vectorize_api-response-common
object
4 properties4 required
vectorize_index-delete-vectors-by-id-request
object
1 property
vectorize_index-get-vectors-by-id-response
array
Array of vectors with matching ids.
vectorize_api-response-common-failure
object
4 properties4 required
vectorize_index-dimensions
integer
Specifies the number of dimensions for the index
vectorize_index-name
string
vectorize_index-description
string
Specifies the description of the index.
vectorize_api-response-single
object
vectorize_index-dimension-configuration
object
2 properties2 required
vectorize_index-metric
string
Specifies the type of metric to use calculating distance.
vectorize_index-delete-vectors-by-id-response
object
2 properties
vectorize_messages
array
vectorize_create-index-response
object
5 properties
vectorize_index-preset
string
Specifies the preset to use for the index.
vectorize_index-preset-configuration
object
1 property1 required
vectorize_identifier
string
Identifier
vectorize_index-get-vectors-by-id-request
object
1 property
vectorize_create-index-request
object
3 properties2 required
vectorize_update-index-request
object
1 property1 required
vectorize_index-query-request
object
5 properties1 required
vectorize_vector-identifier
string
Identifier for a Vector
vectorize_index-configuration
Specifies the type of configuration to use for the index.
vectorize_index-upsert-response
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
