Modify vector store

Update a vector store's name, expiration policy, or metadata.

Example

Request

curl -X POST https://api.upstage.ai/v2/vector_stores/vs_abc123def456 \
  -H "Authorization: Bearer $UPSTAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "updated-docs",
    "metadata": {"team": "product"}
  }'

Response

{
  "id": "vs_abc123def456",
  "object": "vector_store",
  "created_at": 1711644800,
  "name": "updated-docs",
  "usage_bytes": 1024000,
  "file_counts": {
    "in_progress": 0,
    "completed": 3,
    "failed": 0,
    "cancelled": 0,
    "total": 3
  },
  "status": "completed",
  "last_active_at": 1711731200,
  "expires_after": null,
  "expires_at": null,
  "metadata": {"team": "product"}
}

Retrieve vector store

Fetch one vector store by ID. Covers the path parameter, the vector store object returned (name, usage_bytes, file_counts, status, expires_after, metadata), and an example request and response.

Delete vector store

Delete a vector store and every file and vector indexed in it. Covers the path parameter, the deletion confirmation object (id, object, deleted), and an example request and response.

Modify vector store

Example

Request

Response

On this page

Modify vector store

Example

Request

Response

On this page

Authorization

`Authorization`
Required
Bearer <token>

Request Body

`name`string

`expires_after`object

`metadata`object

Path Parameters

`vector_store_id`
Required
string

Response

On this page

Response

On this page

Path

Body

AuthorizationRequiredBearer <token>

namestring

expires_afterobject

Attributes

metadataobject

vector_store_idRequiredstring

`Authorization`
Required
Bearer <token>

`name`string

`expires_after`object

`metadata`object

`vector_store_id`
Required
string