Skip to content
Last updated

🔨 In Development — This section is still being developed and may change.
Modify the name, description, or access settings of a vector store.
PATCHhttps://api.freddy.aitronos.com/v1/organizations/{organization_id}/vector-stores/{vector_store_id}

Update vector store metadata and access control settings.

Path Parameters

organization_id string required

The unique identifier of the organization.

vector_store_id string required

The unique identifier of the vector store to update.

Request Body

name string optional

New name for the vector store.

description string optional

New description for the vector store.

accessMode string optional

New access control level: public, organization, department, or private.

accessDepartments array optional

Updated list of department IDs with access.

accessUsers array optional

Updated list of user IDs with access.


Returns

The updated Vector Store object.

Bash
curl -X PATCH "https://api.freddy.aitronos.com/v1/organizations/org_abc123/vector-stores/vs_abc123" \
  -H "X-API-Key: $FREDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated product documentation",
    "accessMode": "department",
    "accessDepartments": ["dept_engineering", "dept_support"]
  }'

Response

{
  "id": "vs_abc123",
  "name": "Product Documentation",
  "description": "Updated product documentation",
  "organizationId": "org_abc123",
  "isActive": true,
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-20T16:00:00Z",
  "createdBy": "uid_user123",
  "accessMode": "department",
  "accessDepartments": ["dept_engineering", "dept_support"],
  "accessUsers": null,
  "fileCount": 42,
  "dataSize": 15728640
}