Mixedbread stores API is one of 14 APIs that Mixedbread publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Stores. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.
This API exposes
25 operations
across 17 paths,
and defines 91 schemas.
It is described by OpenAPI 3.2.0, at version 0.1.0.
Requests are made against 4 base URLs: https://api.mixedbread.com, https://api.dev.mixedbread.com, http://127.0.0.1:8000, http://localhost:8000.
The identity and technical contract details declared by the specification.
VideoChunkGeneratedMetadata
object
11 properties
RegexFlag
string
Supported regex flags.
ImageUrl-Output
object
Model for image URL validation.
2 properties
1 required
StoreFileConfig
object
Configuration for a file.
1 property
VideoUrl
object
Model for video URL validation.
1 property
1 required
CodeChunkGeneratedMetadata
object
8 properties
1 required
mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleUpdateParams
object
Parameters for updating an existing search rule for a store.
2 properties
ExpiresAfter
object
Represents an expiration policy for a store.
2 properties
ImageUrl-Input
object
Model for image URL validation.
2 properties
1 required
StoreChunkSearchOptions
object
Options for configuring store chunk searches.
6 properties
mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleDeleted
object
Response model for deleted store search rule.
2 properties
1 required
StoreAgenticSearchEvent
object
Represents an agentic search trace in a vector store. Unlike StoreSearchEvent, this captures the full sequence of tool calls the agent issued (name, arguments,…
14 properties
5 required
ConditionOperator
string
Operator for a filter condition.
mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk
object
14 properties
5 required
StoreFileMetadataUpdateParams
object
Parameters for updating metadata on an existing store file.
1 property
ValidationError
object
5 properties
3 required
ImageChunkGeneratedMetadata
object
6 properties
CursorPaginationResponse
object
Response model for cursor-based pagination.
4 properties
3 required
AudioUrl
object
Model for audio URL validation.
1 property
1 required
StoreCreateParams
object
Parameters for creating a new store.
8 properties
TextInputChunk
object
9 properties
1 required
StoreIngestionEvent
object
Represents an ingestion event in a vector store.
12 properties
10 required
MetadataFacets
object
Represents metadata facets for a store.
1 property
1 required
MarkdownChunkGeneratedMetadata
object
11 properties
MarkdownHeading
object
2 properties
2 required
QueryEnhanceQueryItem
object
Enhanced semantic search query with optional filters.
6 properties
1 required
mxbai_omni__core__store__models__chunk_types__ScoredAudioUrlInputChunk
object
15 properties
6 required
StoreFileDeleted
object
Response model for file deletion.
3 properties
1 required
PDFChunkGeneratedMetadata
object
5 properties
mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleResponse
object
Response model for a store search rule.
7 properties
6 required
ChunkSearchResultRule
object
Represents a chunk search result rule for a vector store search.
6 properties
6 required
StoreSearchEventResult
object
A single result captured on a search event.
7 properties
4 required
VideoUrlInputChunk
object
8 properties
1 required
AudioChunkGeneratedMetadata
object
9 properties
FileCounts
object
Tracks counts of files in different states within a store.
6 properties
StoreGrepResponse
object
2 properties
1 required
QueryEnhanceSortItem
object
Ranking request based on metadata.
5 properties
2 required
mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleSpecificDeleteParams
object
Parameters for deleting a specific rule from a search rule array.
1 property
1 required
StoreConfig
object
Configuration for a store.
2 properties
mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleSpecificDeleted
object
Response model for a specific deleted rule from a search rule array.
4 properties
3 required
StoreStatus
string
Status of a store.
mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk
object
15 properties
5 required
SearchFilterCondition
object
Represents a condition with a field, operator, and value.
3 properties
3 required
StoreSearchEvent
object
Represents a search event in a vector store.
14 properties
4 required
StoreChunkSearchParams
object
Query parameters for searching store chunks.
6 properties
2 required
QuestionAnsweringOptions
object
Options for question answering.
2 properties
Store
object
Model representing a store with its metadata and timestamps.
17 properties
4 required
StoreQAResults
object
Results from a question answering operation.
2 properties
1 required
ContextualizationConfig
object
2 properties
StoreChunkFilterParams
object
Parameters for listing store chunks by metadata filter.
6 properties
1 required
SearchCursorPagination
object
Cursor pagination with status, metadata, and a search query.
7 properties
StoreFileListResponse
object
3 properties
2 required
StoreEventHistogramParams
object
Parameters for getting a histogram of events in a store.
4 properties
QueryEnhanceMetadataFilter
object
Metadata filter condition.
3 properties
3 required
RerankConfig
object
Represents a reranking configuration.
3 properties
QueryEnhanceParams
object
Parameters for enhancing a search query.
7 properties
2 required
MetadataFacetsParams
object
Parameters for getting metadata facets.
10 properties
1 required
TextInput
object
Model for text input validation. Attributes: type: Input type identifier, always "text" text: The actual text content, with length and whitespace constraints
2 properties
1 required
StoreChunkGrepTarget
string
Logical chunk content groups the grep tool can match against. These map to one or more underlying chunk fields: - text → text chunks' text field (original text…
ImageUrlInputChunk
object
8 properties
1 required
AgenticSearchTokenUsage
object
Token usage and cost for LLM calls made during an agentic search.
4 properties
QueryStringSubstitutionRule
object
Represents a string query substitution rule for a vector store search.
4 properties
4 required
SearchFilter-Output
object
Represents a filter with AND, OR, and NOT conditions.
3 properties
StoreEventHistogramBucket
object
Represents a histogram of events in a store.
4 properties
4 required
StoreSearchResponse
object
2 properties
1 required
ImageUrlInput
object
Model for image input validation.
2 properties
1 required
StoreEventHistogramResponse
object
2 properties
1 required
AgenticSearchConfig
object
Configuration for agentic multi-query search.
6 properties
AgenticToolCall
object
Represents a single tool call made by the agent during an agentic search. Fields follow the OpenTelemetry GenAI semantic conventions for tool calls: https://op…
8 properties
5 required
mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleCreateParams
object
Parameters for creating a new search rule for a store.
2 properties
2 required
StoreDeleted
object
Response model for store deletion.
3 properties
2 required
FileSearchResultRule
object
Represents a file search result rule for a vector store search.
6 properties
5 required
QueryEnhanceResults
object
Enhanced query response.
1 property
1 required
StoreQAParams
object
Query parameters for question answering.
9 properties
1 required
mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk
object
14 properties
5 required
StoreFileParsingStrategy
string
Strategy for adding a file to a store.
StoreListChunksResponse
object
2 properties
1 required
StoreEventListResponse
object
3 properties
2 required
StoreChunkGrepParams
object
Parameters for matching store chunks against a regular expression. Unlike semantic search, grep performs exact text matching — no embeddings, no reranking. It…
8 properties
2 required
QueryRegexSubstitutionRule
object
Represents a regex query substitution rule for a vector store search.
6 properties
5 required
SearchFilter-Input
object
Represents a filter with AND, OR, and NOT conditions.
3 properties
HTTPValidationError
object
1 property
StoreUpdateParams
object
Parameters for updating an existing store.
6 properties
Body_upload_store_file
object
2 properties
1 required
StoreFile
object
Represents a file stored in a store.
15 properties
4 required
TextChunkGeneratedMetadata
object
8 properties
AudioUrlInputChunk
object
9 properties
2 required
StoreListResponse
object
3 properties
2 required
DeprecatedStoreFileUpsertParams
object
6 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Mixedbread publishes across the network.
