Retrieves a vector store.

GET /vector_stores/{vector_store_id}
Api key auth

Path parameters

  • vector_store_id string Required

    The ID of the vector store to retrieve.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id string Required

      The identifier, which can be referenced in API endpoints.

    • object string Required

      The object type, which is always vector_store.

      Value is vector_store.

    • created_at integer Required

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

    • name string Required

      The name of the vector store.

    • usage_bytes integer Required

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

    • file_counts object Required
      Hide file_counts attributes Show file_counts attributes object
      • in_progress integer Required

        The number of files that are currently being processed.

      • completed integer Required

        The number of files that have been successfully processed.

      • failed integer Required

        The number of files that have failed to process.

      • cancelled integer Required

        The number of files that were cancelled.

      • total integer Required

        The total number of files.

    • status string 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.

      Values are expired, in_progress, or completed.

    • expires_after object

      The expiration policy for a vector store.

      Hide expires_after attributes Show expires_after attributes object
      • anchor string Required

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

        Value is last_active_at.

      • days integer Required

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

        Minimum value is 1, maximum value is 365.

    • expires_at integer | null

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

    • last_active_at integer | null Required

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

    • metadata object | null 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.

      Hide metadata attribute Show metadata attribute object | null
      • * string Additional properties
GET /vector_stores/{vector_store_id} 
curl \
 --request GET 'https://api.openai.com/v1/vector_stores/{vector_store_id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": "string",
  "object": "vector_store",
  "created_at": 42,
  "name": "string",
  "usage_bytes": 42,
  "file_counts": {
    "in_progress": 42,
    "completed": 42,
    "failed": 42,
    "cancelled": 42,
    "total": 42
  },
  "status": "expired",
  "expires_after": {
    "anchor": "last_active_at",
    "days": 42
  },
  "expires_at": 42,
  "last_active_at": 42,
  "metadata": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  }
}