API Reference

Vector Stores

Files

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update vector store file attributes

$ openai vector-stores:files update

POST/vector_stores/{vector_store_id}/files/{file_id}

Update attributes on a vector store file.

ParametersExpand Collapse

--vector-store-id: string

The ID of the vector store the file belongs to.

--file-id: string

The ID of the file to update attributes.

--attributes: map[string or number or boolean]

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, booleans, or numbers.

ReturnsExpand Collapse

vector_store_file: object { id, created_at, last_error, 6 more }

A list of files attached to a vector store.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

last_error: object { code, message }

The last error associated with this vector store file. Will be null if there are no errors.

object: "vector_store.file"

The object type, which is always vector_store.file.

status: "in_progress" or "completed" or "cancelled" or "failed"

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

usage_bytes: number

The total vector store usage in bytes. Note that this may be different from the original file size.

vector_store_id: string

The ID of the vector store that the File is attached to.

attributes: optional map[string or number or boolean]

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, booleans, or numbers.

chunking_strategy: optional StaticFileChunkingStrategyObject { static, type } or OtherFileChunkingStrategyObject { type }

The strategy used to chunk the file.

Update vector store file attributes

CLI Tool

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

openai vector-stores:files update \
  --api-key 'My API Key' \
  --vector-store-id vs_abc123 \
  --file-id file-abc123 \
  --attributes '{foo: string}'

{
  "id": "file-abc123",
  "object": "vector_store.file",
  "usage_bytes": 1234,
  "created_at": 1699061776,
  "vector_store_id": "vs_abcd",
  "status": "completed",
  "last_error": null,
  "chunking_strategy": {...},
  "attributes": {"key1": "value1", "key2": 2}
}

Returns Examples

{
  "id": "file-abc123",
  "object": "vector_store.file",
  "usage_bytes": 1234,
  "created_at": 1699061776,
  "vector_store_id": "vs_abcd",
  "status": "completed",
  "last_error": null,
  "chunking_strategy": {...},
  "attributes": {"key1": "value1", "key2": 2}
}