APIs.io Engineering Platform Vectorize API

The Vectorize API from APIs.io Engineering Platform — 11 operation(s) for vectorize.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 13 operations across 11 paths, and defines 31 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.

13 operations 11 paths 31 schemas 1 DELETE4 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Vectorize 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 13

Across 11 paths, the API surfaces 13 operations — 1 DELETE, 4 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Vectorize 13

GET

/accounts/{account_id}/vectorize/v2/indexes

APIs.io Engineering Platform List Vectorize Indexes

vectorize-list-vectorize-indexes 1 param → 4XX200

POST

/accounts/{account_id}/vectorize/v2/indexes

APIs.io Engineering Platform Create Vectorize Index

vectorize-create-vectorize-index 1 param body → 4XX200

DELETE

/accounts/{account_id}/vectorize/v2/indexes/{index_name}

APIs.io Engineering Platform Delete Vectorize Index

vectorize-delete-vectorize-index 2 params → 4XX200

GET

/accounts/{account_id}/vectorize/v2/indexes/{index_name}

APIs.io Engineering Platform Get Vectorize Index

vectorize-get-vectorize-index 2 params → 4XX200

POST

/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids

APIs.io Engineering Platform Delete Vectors By Identifier

vectorize-delete-vectors-by-id 2 params body → 4XX200

POST

/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids

APIs.io Engineering Platform Get Vectors By Identifier

vectorize-get-vectors-by-id 2 params body → 4XX200

GET

/accounts/{account_id}/vectorize/v2/indexes/{index_name}/info

APIs.io Engineering Platform Get Vectorize Index Info

vectorize-index-info 2 params → 4XX200

POST

/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert

APIs.io Engineering Platform Insert Vectors

vectorize-insert-vector 3 params body → 4XX200

POST

/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create

APIs.io Engineering Platform Create Metadata Index

vectorize-create-metadata-index 2 params body → 4XX200

POST

/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete

APIs.io Engineering Platform Delete Metadata Index

vectorize-delete-metadata-index 2 params body → 4XX200

GET

/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list

APIs.io Engineering Platform List Metadata Indexes

vectorize-list-metadata-indexes 2 params → 4XX200

POST

/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query

APIs.io Engineering Platform Query Vectors

vectorize-query-vector 2 params body → 4XX200

POST

/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert

APIs.io Engineering Platform Upsert Vectors

vectorize-upsert-vector 3 params body → 4XX200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are vectorize_create-index-response (5 properties), vectorize_index-query-v2-request (5 properties), vectorize_index-info-response (4 properties), vectorize_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

vectorize_index-delete-vectors-by-id-v2-response

object

1 property

vectorize_mutation-uuid

The unique identifier for the async mutation operation containing the changeset.

vectorize_create-metadata-index-request

object

2 properties 2 required

vectorize_api-response-common

object

4 properties 4 required

vectorize_index-query-v2-response

object

2 properties

vectorize_index-query-v2-request

object

5 properties 1 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_index-dimensions

integer

Specifies the number of dimensions for the index

vectorize_api-response-common-failure

object

4 properties 4 required

vectorize_index-name

string

vectorize_index-description

string

Specifies the description of the index.

vectorize_api-response-single

object

vectorize_delete-metadata-index-request

object

1 property 1 required

vectorize_index-dimension-configuration

object

2 properties 2 required

vectorize_index-metric

string

Specifies the type of metric to use calculating distance.

vectorize_messages

array

vectorize_create-index-response

object

5 properties

vectorize_index-insert-v2-response

object

1 property

vectorize_index-preset

string

Specifies the preset to use for the index.

vectorize_index-info-response

object

4 properties

vectorize_create-metadata-index-response

object

1 property

vectorize_index-preset-configuration

object

1 property 1 required

vectorize_identifier

string

Identifier

vectorize_index-upsert-v2-response

object

1 property

vectorize_index-get-vectors-by-id-request

object

1 property

vectorize_create-index-request

object

3 properties 2 required

vectorize_list-metadata-index-response

object

1 property

vectorize_delete-metadata-index-response

object

1 property

vectorize_vector-identifier

string

Identifier for a Vector

vectorize_index-configuration

Specifies the type of configuration to use for the index.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Vectorize

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Vectorize API

Metadata

Authentication & Security 1

Paths & Operations 13

Schemas 31

Specification

Source

API Details

Provider

Explore more