OMomnistack-sh
Vector stores

Create vector store

Changed on

Create a vector store.

post/vector_stores

Request

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

Request body

file_idsstring[]

A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.

namestring

The name of the vector store.

descriptionstring

A description for the vector store. Can be used to describe the vector store's purpose.

metadataMetadata nullable

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

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

  • 487892d3954eRevision changes
    • info

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

    • info

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

    • info

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

  • 7f654af7f94fRevision changes
    • breaking

      the request property became not nullable

    • breaking

      response property expires_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property last_active_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property metadata list-of-types was widened by adding types null to media type application/json of response 200

    • info

      api tag Vector stores added

    • info

      api tag Vector Stores removed

    • info

      added the new optional request property

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status