Modify vector store

POSThttps:/api.openai.com/v1/vector_stores/{vector_store_id}

Modifies a vector store.

Path parameters

  • vector_store_id
    string
    Required
    The ID of the vector store to modify.

Request body

  • name
    string or null
    The name of the vector store.
  • expires_after
    object
  • metadata
    object or null
    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Response

The modified vector store object.

Example request
1
curl https://api.openai.com/v1/vector_stores/vs_abc123 \

2
  -H "Authorization: Bearer $OPENAI_API_KEY" \

3
  -H "Content-Type: application/json" \

4
  -H "OpenAI-Beta: assistants=v2"

5
  -d '{

6
    "name": "Support FAQ"

7
  }'
Example response
1
{

2
  "id": "vs_abc123",

3
  "object": "vector_store",

4
  "created_at": 1699061776,

5
  "name": "Support FAQ",

6
  "bytes": 139920,

7
  "file_counts": {

8
    "in_progress": 0,

9
    "completed": 3,

10
    "failed": 0,

11
    "cancelled": 0,

12
    "total": 3

13
  }

14
}
Built with