API Reference
Modify a vector store
Updates the knowledge base name (display_name) and description.
POST
/
v1
/
vector_stores
/
{vector_store_id}
Modify a vector store
curl --request POST \
--url https://api.synapsai.cloud/v1/vector_stores/{vector_store_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.synapsai.cloud/v1/vector_stores/{vector_store_id}"
payload = {
"name": "<string>",
"description": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"object": "vector_store",
"name": "<string>",
"status": "in_progress",
"created_at": 123,
"description": "<string>",
"file_counts": {
"in_progress": 123,
"completed": 123,
"failed": 123,
"cancelled": 123,
"total": 123
},
"last_active_at": 123,
"metadata": {},
"usage_bytes": 123,
"expires_at": 123
}Response
Updated vector store
OpenAI vector store object. This is a knowledge base.
⌘I
Modify a vector store
curl --request POST \
--url https://api.synapsai.cloud/v1/vector_stores/{vector_store_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.synapsai.cloud/v1/vector_stores/{vector_store_id}"
payload = {
"name": "<string>",
"description": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"object": "vector_store",
"name": "<string>",
"status": "in_progress",
"created_at": 123,
"description": "<string>",
"file_counts": {
"in_progress": 123,
"completed": 123,
"failed": 123,
"cancelled": 123,
"total": 123
},
"last_active_at": 123,
"metadata": {},
"usage_bytes": 123,
"expires_at": 123
}