Mixedbread

Files

Overview

File management provides secure upload, storage, and retrieval of documents for use with parsing and vector store operations. Files serve as the foundation for all content processing workflows.

Upload File

POST/v1/files

Uploads a file to Mixedbread for use with parsing and vector store operations. Files are securely stored and can be referenced by their unique ID.

Authorization

  • Authorization
    Authorization
    Type
    string
    Required or Optional
    required
    Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Request Body

  • file
    file
    Type
    binary
    Required or Optional
    required
    The binary content of the file being uploaded.

Response Body

  • id
    id
    Type
    string
    Required or Optional
    required
    The unique identifier for the uploaded file.
  • filename
    filename
    Type
    string
    Required or Optional
    required
    The name of the file including its extension.
  • bytes
    bytes
    Type
    integer
    Required or Optional
    required
    The size of the file in bytes.
  • mime_type
    mime_type
    Type
    string
    Required or Optional
    required
    The detected MIME type of the file.
  • version
    version
    Type
    integer
    Required or Optional
    required
    The version number of the file.
  • created_at
    created_at
    Type
    string
    Required or Optional
    required
    The timestamp indicating when the resource was created.
  • updated_at
    updated_at
    Type
    string
    Required or Optional
    required
    The timestamp indicating when the resource was last updated.
  • object
    object
    Type
    string
    Required or Optional
    required
    The type of this object.

Retrieve File

GET/v1/files/{file_id}

Retrieves metadata about a specific file including size, type, upload date, and current status.

Authorization

  • Authorization
    Authorization
    Type
    string
    Required or Optional
    required
    Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Path Parameter

  • file_id
    file_id
    Type
    string
    Required or Optional
    required
    The unique identifier of the target file.

Response Body

  • id
    id
    Type
    string
    Required or Optional
    required
    The unique identifier for the file.
  • filename
    filename
    Type
    string
    Required or Optional
    required
    The name of the file including its extension.
  • bytes
    bytes
    Type
    integer
    Required or Optional
    required
    The size of the file in bytes.
  • mime_type
    mime_type
    Type
    string
    Required or Optional
    required
    The detected MIME type of the file.
  • version
    version
    Type
    integer
    Required or Optional
    required
    The version number of the file.
  • created_at
    created_at
    Type
    string
    Required or Optional
    required
    The timestamp indicating when the resource was created.
  • updated_at
    updated_at
    Type
    string
    Required or Optional
    required
    The timestamp indicating when the resource was last updated.
  • object
    object
    Type
    string
    Required or Optional
    required
    The type of this object.

Update File

POST/v1/files/{file_id}

Replaces an existing file with new content while maintaining the same file ID and associated relationships.

Authorization

  • Authorization
    Authorization
    Type
    string
    Required or Optional
    required
    Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Path Parameter

  • file_id
    file_id
    Type
    string
    Required or Optional
    required
    The unique identifier of the target file.

Request Body

  • file
    file
    Type
    binary
    Required or Optional
    required
    The binary content of the file being updated.

Response Body

  • id
    id
    Type
    string
    Required or Optional
    required
    The unique identifier for the file.
  • filename
    filename
    Type
    string
    Required or Optional
    required
    The name of the file including its extension.
  • bytes
    bytes
    Type
    integer
    Required or Optional
    required
    The size of the updated file in bytes.
  • mime_type
    mime_type
    Type
    string
    Required or Optional
    required
    The detected MIME type of the updated file.
  • version
    version
    Type
    integer
    Required or Optional
    required
    The new version number of the file.
  • created_at
    created_at
    Type
    string
    Required or Optional
    required
    The original creation timestamp of the file.
  • updated_at
    updated_at
    Type
    string
    Required or Optional
    required
    The timestamp indicating when this update occurred.
  • object
    object
    Type
    string
    Required or Optional
    required
    The type of this object.

List Files

GET/v1/files

Retrieves a paginated list of all files in your account with summary information and status.

Authorization

  • Authorization
    Authorization
    Type
    string
    Required or Optional
    required
    Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Query Parameters

  • limit
    limit
    Type
    integer
    Required or Optional
    optional
    The maximum number of items to return in the list.
  • offset
    offset
    Type
    integer
    Required or Optional
    optional
    The number of items to skip before starting the list.

Response Body

  • object
    object
    Type
    string
    Required or Optional
    required
    The type of the response object.
  • data
    data
    Type
    FileObject[]
    Required or Optional
    required
    A list containing the file objects.
  • An object containing pagination details for the list.

Delete File

DELETE/v1/files/{file_id}

Permanently deletes a file and removes it from any associated vector stores. This action cannot be undone.

Authorization

  • Authorization
    Authorization
    Type
    string
    Required or Optional
    required
    Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Path Parameter

  • file_id
    file_id
    Type
    string
    Required or Optional
    required
    The unique identifier of the target file.

Response Body

  • id
    id
    Type
    string
    Required or Optional
    required
    The ID of the deleted file.
  • deleted
    deleted
    Type
    boolean
    Required or Optional
    required
    A boolean indicating whether the deletion was successful.
  • object
    object
    Type
    string
    Required or Optional
    required
    The type of this object.

Download File Content

GET/v1/files/{file_id}/content

Downloads the original file content as a binary stream with appropriate content headers.

Authorization

  • Authorization
    Authorization
    Type
    string
    Required or Optional
    required
    Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Path Parameter

  • file_id
    file_id
    Type
    string
    Required or Optional
    required
    The unique identifier of the target file.

Response Body

  • content
    content
    Type
    binary
    Required or Optional
    required
    The raw binary content of the file.
Embeddings
API reference for Mixedbread's Embeddings endpoint. This documentation covers all essential endpoints to get you started with embeddings.
Parsing
API reference for managing document parsing in Mixedbread. This documentation covers all essential endpoints to get you started with document parsing.

Last updated: June 11, 2025