Vector stores

Retrieve vector store

Changed on

Retrieves a vector store.

get/vector_stores/{vector_store_id}

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/vector_stores/{vector_store_id}
  • Auth
    HTTP bearer

Path parameters

vector_store_idstring required

The ID of the vector store to retrieve.

Response

OK

idstring required

The identifier, which can be referenced in API endpoints.

object'vector_store' required

The object type, which is always vector_store.

created_atinteger required

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

namestring required

The name of the vector store.

usage_bytesinteger required

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

status'expired' | 'in_progress' | 'completed' required

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.

expires_atinteger nullable

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

last_active_atinteger nullable required

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

metadataMetadata nullable required

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.

Changes

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • d86203de41aeRevision changes
    • info

      added the non-success response with the status