Create Store

POST/v1/stores

AuthorizationLink to section

Authorizationstringrequired

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

Request BodyLink to section

namestring

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

Constraints

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

descriptionstring

Description of the store

is_publicbooleandefault: false

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

expires_afterExpiresAfter

Optional expiration policy

metadataobject

Optional metadata key-value pairs

file_idsarray

Optional list of file IDs

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: 100•Pattern: lowercase letters, numbers, periods, hyphens

descriptionstring

Detailed description of the store's purpose and contents

is_publicbooleandefault: false

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

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

POST/v1/stores

from mixedbread import Mixedbread

mxbai = Mixedbread(api_key="YOUR_API_KEY")

store = mxbai.stores.create(
    name="my-knowledge-base", description="Product documentation and FAQs"
)

print(store)

Response

JSON

{
  "id": "vs_abc123",
  "object": "store",
  "name": "my-knowledge-base",
  "description": "Product documentation and FAQs",
  "is_public": false,
  "metadata": {},
  "config": {
    "contextualization": false
  },
  "file_counts": {
    "in_progress": 0,
    "completed": 0,
    "failed": 0,
    "cancelled": 0,
    "pending": 0,
    "total": 0
  },
  "status": "completed",
  "usage_bytes": 0,
  "expires_after": null,
  "expires_at": null,
  "created_at": "2025-01-15T10:30:00.000Z",
  "updated_at": "2025-01-15T10:30:00.000Z",
  "last_active_at": null
}