Get Store

GET/v1/stores/{store_identifier}

AuthorizationLink to section

Authorizationstringrequired

Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Path ParametersLink to section

store_identifierstringrequired

The ID or name of the store

Response BodyLink to section

idstringrequired

Unique identifier for the store

namestringrequired

Name of the store. Can only contain lowercase letters, numbers, periods (.), and hyphens (-).

Constraints

•Minimum length: 1•Maximum length: 60•Pattern: lowercase letters, numbers, periods, hyphens

descriptionstring

Detailed description of the store's purpose and contents

Constraints

•Maximum length: 256

is_publicbooleandefault: false

Whether the store can be accessed by anyone with valid login credentials

licensestring

License for public stores

metadataobject

Additional metadata associated with the store

expires_afterExpiresAfter

Optional expiration policy

statusenum

Status of a store.

Possible values

expiredin_progresscompleted

created_atstring(date-time)required

Timestamp when the store was created

updated_atstring(date-time)required

Timestamp when the store was last updated

last_active_atstring

Timestamp when the store was last used

usage_bytesintegerdefault: 0

Total storage usage in bytes

expires_atstring

Optional expiration timestamp for the store

objectstringdefault: store

Type of the object

Request

GET/v1/stores/{store_identifier}

from mixedbread import Mixedbread

mxbai = Mixedbread(api_key="YOUR_API_KEY")

store = mxbai.stores.retrieve(store_identifier="my-knowledge-base")

print(store)

Response

JSON

{
  "id": "vs_abc123",
  "object": "store",
  "name": "{{STORE_ID}}",
  "description": "Product documentation and FAQs",
  "is_public": false,
  "metadata": {},
  "file_counts": {
    "in_progress": 0,
    "completed": 5,
    "failed": 0,
    "cancelled": 0,
    "pending": 0,
    "total": 5
  },
  "status": "completed",
  "usage_bytes": 1048576,
  "expires_after": null,
  "expires_at": null,
  "created_at": "2025-01-15T10:30:00.000Z",
  "updated_at": "2025-01-15T11:45:00.000Z",
  "last_active_at": "2025-01-15T12:00:00.000Z"
}