Memory Stores

Endpoints for managing memory stores (vector stores) and document search.

get

Perform a search on a memory store.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
memory_store_idstringRequired

The Memory Store id

Query parameters
querystringRequired

The query to search for

topkinteger · min: 1 · max: 1000Optional

The number of results to return

Example: 10
Responses
chevron-right
200

Results found

application/json
get
/public_api/vector_stores/{memory_store_id}/search

Add Document

post

Add a document to a memory store.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
memory_store_idstringRequired

The Memory Store id

Body
textstringRequired

The content of the document

namestringRequired

The name of the document

metadataobjectOptional

The metadata of the document

Responses
chevron-right
200

Document added

application/json
post
/public_api/vector_stores/{memory_store_id}/vector_store_documents

Update Document

put

Update a document in a memory store.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
memory_store_idstringRequired

The Memory Store id

memory_store_document_idstringRequired

The id of the document to update

Body
textstringRequired

The content of the document

namestringRequired

The name of the document

metadataobjectOptional

The metadata of the document

Responses
chevron-right
200

Document updated

application/json
put
/public_api/vector_stores/{memory_store_id}/vector_store_documents/{memory_store_document_id}

Delete Document

delete

Delete a document from a memory store.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
memory_store_idstringRequired

The Memory Store id

memory_store_document_idstringRequired

The id of the document to delete

Responses
chevron-right
200

Document deleted

No content

delete
/public_api/vector_stores/{memory_store_id}/vector_store_documents/{memory_store_document_id}

No content

Last updated

Was this helpful?