v1

latestOpenAPI 3.0.22026-07-173834119.9 KB
Vectorization

Create Opensearch Collection

Endpoint to Create a Vector Store

This endpoint creates a vector store and returns the store ID that can be used to create an index.


Request Body

FieldTypeDescription
store_typestrThe type of the vector store.
descriptionstrThe description of the vector store.
tagsOptional[Dict[str, str]]Tags to associate with the vector store.

Example Request Body

```json

{
    "store_type": "opensearchserverless",
    "description": "A vector store for semantic search.",
    "tags": {
        "environment": "production",
        "team": "data"
    }
}

```

Response Body

FieldTypeDescription
store_namestrThe name of the created store.
store_typestrThe type of the created store.
store_idstrThe ID of the created store.
messagestrA message indicating the status of the operation.

Errors

  • 400 Bad Request: If the store type is not supported.
  • 500 Internal Server Error: If there is an unexpected error during the creation of the vector store.
post/vector/store/create

Request body

store_namestring required
store_typestring required
descriptionstring
tagsobject[]

Response

Successful Response

store_namestring required
store_typestring required
store_idstring required
messagestring required