api.md

Shared Types

from mixedbread.types import SearchFilter, SearchFilterCondition, Usage

Mixedbread

Types:

from mixedbread.types import (
    Embedding,
    EmbeddingCreateResponse,
    MultiEncodingEmbedding,
    InfoResponse,
    RerankResponse,
)

Methods:

• client.embed(**params) -> EmbeddingCreateResponse
• client.info() -> InfoResponse
• client.rerank(**params) -> RerankResponse

Stores

Types:

from mixedbread.types import (
    AgenticSearchConfig,
    AudioChunkGeneratedMetadata,
    AudioURL,
    CodeChunkGeneratedMetadata,
    ContextualizationConfig,
    ExpiresAfter,
    FileCounts,
    ImageChunkGeneratedMetadata,
    ImageURLOutput,
    MarkdownChunkGeneratedMetadata,
    MarkdownHeading,
    PdfChunkGeneratedMetadata,
    RerankConfig,
    ScoredAudioURLInputChunk,
    ScoredImageURLInputChunk,
    ScoredTextInputChunk,
    ScoredVideoURLInputChunk,
    Store,
    StoreChunkSearchOptions,
    StoreConfig,
    TextChunkGeneratedMetadata,
    VideoChunkGeneratedMetadata,
    VideoURL,
    StoreDeleteResponse,
    StoreMetadataFacetsResponse,
    StoreQuestionAnsweringResponse,
    StoreSearchResponse,
)

Methods:

• client.stores.create(**params) -> Store
• client.stores.retrieve(store_identifier) -> Store
• client.stores.update(store_identifier, **params) -> Store
• client.stores.list(**params) -> SyncCursor[Store]
• client.stores.delete(store_identifier) -> StoreDeleteResponse
• client.stores.metadata_facets(**params) -> StoreMetadataFacetsResponse
• client.stores.question_answering(**params) -> StoreQuestionAnsweringResponse
• client.stores.search(**params) -> StoreSearchResponse

Files

Types:

from mixedbread.types.stores import (
    AudioURLInputChunk,
    ImageURLInputChunk,
    StoreFile,
    StoreFileConfig,
    StoreFileStatus,
    TextInputChunk,
    VideoURLInputChunk,
    FileListResponse,
    FileDeleteResponse,
)

Methods:

• client.stores.files.create(store_identifier, **params) -> StoreFile
• client.stores.files.retrieve(file_identifier, *, store_identifier, **params) -> StoreFile
• client.stores.files.update(file_identifier, *, store_identifier, **params) -> StoreFile
• client.stores.files.list(store_identifier, **params) -> FileListResponse
• client.stores.files.delete(file_identifier, *, store_identifier) -> FileDeleteResponse

Parsing

Jobs

Types:

from mixedbread.types.parsing import (
    Chunk,
    ChunkElement,
    ChunkingStrategy,
    DocumentParserResult,
    ElementType,
    ParsingJob,
    ParsingJobStatus,
    ReturnFormat,
    JobListResponse,
    JobDeleteResponse,
)

Methods:

• client.parsing.jobs.create(**params) -> ParsingJob
• client.parsing.jobs.retrieve(job_id) -> ParsingJob
• client.parsing.jobs.list(**params) -> SyncCursor[JobListResponse]
• client.parsing.jobs.delete(job_id) -> JobDeleteResponse
• client.parsing.jobs.cancel(job_id) -> ParsingJob

Files

Types:

from mixedbread.types import FileObject, PaginationWithTotal, FileDeleteResponse

Methods:

• client.files.create(**params) -> FileObject
• client.files.retrieve(file_id) -> FileObject
• client.files.update(file_id, **params) -> FileObject
• client.files.list(**params) -> SyncCursor[FileObject]
• client.files.delete(file_id) -> FileDeleteResponse
• client.files.content(file_id) -> BinaryAPIResponse

Uploads

Types:

from mixedbread.types.files import (
    MultipartUploadPart,
    MultipartUploadPartURL,
    UploadCreateResponse,
    UploadRetrieveResponse,
    UploadListResponse,
    UploadAbortResponse,
)

Methods:

• client.files.uploads.create(**params) -> UploadCreateResponse
• client.files.uploads.retrieve(upload_id) -> UploadRetrieveResponse
• client.files.uploads.list() -> UploadListResponse
• client.files.uploads.abort(upload_id) -> UploadAbortResponse
• client.files.uploads.complete(upload_id, **params) -> FileObject

Extractions

Jobs

Types:

from mixedbread.types.extractions import ExtractionJob

Methods:

• client.extractions.jobs.create(**params) -> ExtractionJob
• client.extractions.jobs.retrieve(job_id) -> ExtractionJob

Schema

Types:

from mixedbread.types.extractions import CreatedJsonSchema, EnhancedJsonSchema, ValidatedJsonSchema

Methods:

• client.extractions.schema.create(**params) -> CreatedJsonSchema
• client.extractions.schema.enhance(**params) -> EnhancedJsonSchema
• client.extractions.schema.validate(**params) -> ValidatedJsonSchema

Content

Types:

from mixedbread.types.extractions import ExtractionResult, ImageURLInput, TextInput

Methods:

• client.extractions.content.create(**params) -> ExtractionResult

Embeddings

Types:

from mixedbread.types import EncodingFormat

Methods:

• client.embeddings.create(**params) -> EmbeddingCreateResponse

DataSources

Types:

from mixedbread.types import (
    APIKeyCreateOrUpdateParams,
    DataSource,
    DataSourceAPIKeyParams,
    DataSourceOauth2Params,
    DataSourceType,
    LinearDataSource,
    NotionDataSource,
    Oauth2Params,
    DataSourceDeleteResponse,
)

Methods:

• client.data_sources.create(**params) -> DataSource
• client.data_sources.retrieve(data_source_id) -> DataSource
• client.data_sources.update(data_source_id, **params) -> DataSource
• client.data_sources.list(**params) -> SyncCursor[DataSource]
• client.data_sources.delete(data_source_id) -> DataSourceDeleteResponse

Connectors

Types:

from mixedbread.types.data_sources import DataSourceConnector, ConnectorDeleteResponse

Methods:

• client.data_sources.connectors.create(data_source_id, **params) -> DataSourceConnector
• client.data_sources.connectors.retrieve(connector_id, *, data_source_id) -> DataSourceConnector
• client.data_sources.connectors.update(connector_id, *, data_source_id, **params) -> DataSourceConnector
• client.data_sources.connectors.list(data_source_id, **params) -> SyncCursor[DataSourceConnector]
• client.data_sources.connectors.delete(connector_id, *, data_source_id) -> ConnectorDeleteResponse

APIKeys

Types:

from mixedbread.types import APIKey, APIKeyCreated, Scope, APIKeyDeleteResponse

Methods:

• client.api_keys.create(**params) -> APIKeyCreated
• client.api_keys.retrieve(api_key_id) -> APIKey
• client.api_keys.list(**params) -> SyncLimitOffset[APIKey]
• client.api_keys.delete(api_key_id) -> APIKeyDeleteResponse
• client.api_keys.reroll(api_key_id) -> APIKeyCreated
• client.api_keys.revoke(api_key_id) -> APIKey

Chat

Methods:

• client.chat.create_completion() -> object