update.md

Modify vector store

post /vector_stores/{vector_store_id}

Modifies a vector store.

Path Parameters

• vector_store_id: string

  The ID of the vector store to modify.

Body Parameters

Content type: application/json

• expires_after: optional object { anchor, days } or null

  The expiration policy for a vector store.

  • anchor: "last_active_at"

    Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.

    • "last_active_at"

  • days: integer

    The number of days after the anchor time that the vector store will expire.

    minimum: 1, maximum: 365

• metadata: optional Metadata 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.

• name: optional string or null

  The name of the vector store.

Returns

• VectorStore object { id, created_at, file_counts, 8 more }

  A vector store is a collection of processed files can be used by the file_search tool.

  • id: string

    The identifier, which can be referenced in API endpoints.

  • created_at: integer

    The Unix timestamp (in seconds) for when the vector store was created.

    format: unixtime

  • file_counts: object { cancelled, completed, failed, 2 more }

    • cancelled: integer

      The number of files that were cancelled.

    • completed: integer

      The number of files that have been successfully processed.

    • failed: integer

      The number of files that have failed to process.

    • in_progress: integer

      The number of files that are currently being processed.

    • total: integer

      The total number of files.

  • last_active_at: integer or null

    The Unix timestamp (in seconds) for when the vector store was last active.

    format: unixtime

  • metadata: Metadata 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.

  • name: string

    The name of the vector store.

  • object: "vector_store"

    The object type, which is always vector_store.

    • "vector_store"

  • status: "expired" or "in_progress" or "completed"

    The status of the vector store, which can be either expired, in_progress, or completed. A status of completed indicates that the vector store is ready for use.

    • "expired"

    • "in_progress"

    • "completed"

  • usage_bytes: integer

    The total number of bytes used by the files in the vector store.

  • expires_after: optional object { anchor, days }

    The expiration policy for a vector store.

    • anchor: "last_active_at"

      Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.

      • "last_active_at"

    • days: integer

      The number of days after the anchor time that the vector store will expire.

      minimum: 1, maximum: 365

  • expires_at: optional integer or null

    The Unix timestamp (in seconds) for when the vector store will expire.

    format: unixtime

Example

curl https://api.openai.com/v1/vector_stores/$VECTOR_STORE_ID \
    -H 'Content-Type: application/json' \
    -H 'OpenAI-Beta: assistants=v2' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{}'

200 — Example

{
  "id": "id",
  "created_at": 0,
  "file_counts": {
    "cancelled": 0,
    "completed": 0,
    "failed": 0,
    "in_progress": 0,
    "total": 0
  },
  "last_active_at": 0,
  "metadata": {
    "foo": "string"
  },
  "name": "name",
  "object": "vector_store",
  "status": "expired",
  "usage_bytes": 0,
  "expires_after": {
    "anchor": "last_active_at",
    "days": 1
  },
  "expires_at": 0
}

Example

curl https://api.openai.com/v1/vector_stores/vs_abc123 \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "OpenAI-Beta: assistants=v2"
  -d '{
    "name": "Support FAQ"
  }'

Response example

{
  "id": "vs_abc123",
  "object": "vector_store",
  "created_at": 1699061776,
  "name": "Support FAQ",
  "description": "Contains commonly asked questions and answers, organized by topic.",
  "file_counts": {
    "in_progress": 0,
    "completed": 3,
    "failed": 0,
    "cancelled": 0,
    "total": 3
  },
  "usage_bytes": 139920,
  "status": "completed",
  "last_active_at": null,
  "metadata": {}
}