Developer-friendly & type-safe Python SDK specifically catered to leverage mix-python-sdk API.
Mix REST API: REST API for the Mix application - session management, messaging, and system operations
Note
Python version upgrade policy
Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
The SDK can be installed with uv, pip, or poetry package managers.
uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
uv add mix-python-sdkPIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install mix-python-sdkPoetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.
poetry add mix-python-sdkYou can also install the package directly from GitHub:
pip install git+https://github.com/recreate-run/mix-python-sdk.gitYou can use this SDK in a Python shell with uv and the uvx command that comes with it like so:
uvx --from mix-python-sdk pythonIt's also possible to write a standalone Python script without needing to set up a whole project like so:
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
# "mix-python-sdk",
# ]
# ///
from mix_python_sdk import Mix
sdk = Mix(
# SDK arguments
)
# Rest of script here...Once that is saved to a file, you can run it with uv run script.py where
script.py can be replaced with the actual file name.
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
# Synchronous Example
from mix_python_sdk import Mix
with Mix() as mix:
res = mix.authentication.store_api_key(api_key="<value>", provider="openrouter")
# Handle response
print(res)The same SDK client can also be used to make asynchronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from mix_python_sdk import Mix
async def main():
async with Mix() as mix:
res = await mix.authentication.store_api_key_async(api_key="<value>", provider="openrouter")
# Handle response
print(res)
asyncio.run(main())Available methods
- store_api_key - Store API key
- set_api_key - Set API key
- initiate_o_auth_login - OAuth authentication
- handle_o_auth_callback - Handle OAuth callback
- start_o_auth_flow - Start OAuth authentication
- get_auth_status - Get authentication status
- validate_preferred_provider - Validate preferred provider
- delete_credentials - Delete provider credentials
- list_session_files - List session files
- upload_session_file - Upload file to session
- delete_session_file - Delete session file
- get_session_file - Get session file
- get_history - Get global message history
- list_session - List session messages
- send - Send a message to session
- get_preferences - Get user preferences
- update_preferences - Update user preferences
- get_available_providers - Get available providers
- reset_preferences - Reset preferences
- list - List all sessions
- create - Create a new session
- delete - Delete a session
- get - Get a specific session
- fork - Fork a session
- cancel_processing - Cancel agent processing
- list_commands - List available commands
- get_command - Get specific command
- list_mcp_servers - List MCP servers
- get_health - Health check
Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
Tip
For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
from mix_python_sdk import Mix
with Mix() as mix:
res = mix.files.upload_session_file(id="<id>", file={
"file_name": "example.file",
"content": open("example.file", "rb"),
})
# Handle response
print(res)Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:
from mix_python_sdk import Mix
from mix_python_sdk.utils import BackoffStrategy, RetryConfig
with Mix() as mix:
res = mix.authentication.store_api_key(api_key="<value>", provider="openrouter",
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Handle response
print(res)If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:
from mix_python_sdk import Mix
from mix_python_sdk.utils import BackoffStrategy, RetryConfig
with Mix(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as mix:
res = mix.authentication.store_api_key(api_key="<value>", provider="openrouter")
# Handle response
print(res)MixError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
|---|---|---|
err.message |
str |
Error message |
err.status_code |
int |
HTTP response status code eg 404 |
err.headers |
httpx.Headers |
HTTP response headers |
err.body |
str |
HTTP body. Can be empty string if no body is returned. |
err.raw_response |
httpx.Response |
Raw HTTP response |
err.data |
Optional. Some errors may contain structured data. See Error Classes. |
from mix_python_sdk import Mix, errors
with Mix() as mix:
res = None
try:
res = mix.authentication.store_api_key(api_key="<value>", provider="openrouter")
# Handle response
print(res)
except errors.MixError as e:
# The base class for HTTP error responses
print(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
# Depending on the method different errors may be thrown
if isinstance(e, errors.ErrorResponse):
print(e.data.error) # models.RESTErrorPrimary errors:
MixError: The base class for HTTP error responses.ErrorResponse: Generic error.
Less common errors (5)
Network errors:
httpx.RequestError: Base class for request errors.httpx.ConnectError: HTTP client was unable to make a request to a server.httpx.TimeoutException: HTTP request timed out.
Inherit from MixError:
ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via thecauseattribute.
The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
from mix_python_sdk import Mix
with Mix(
server_url="http://localhost:8088",
) as mix:
res = mix.authentication.store_api_key(api_key="<value>", provider="openrouter")
# Handle response
print(res)The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
from mix_python_sdk import Mix
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Mix(client=http_client)or you could wrap the client with your own custom logic:
from mix_python_sdk import Mix
from mix_python_sdk.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = Mix(async_client=CustomClient(httpx.AsyncClient()))The Mix class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.
from mix_python_sdk import Mix
def main():
with Mix() as mix:
# Rest of application here...
# Or when using async:
async def amain():
async with Mix() as mix:
# Rest of application here...You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
from mix_python_sdk import Mix
import logging
logging.basicConfig(level=logging.DEBUG)
s = Mix(debug_logger=logging.getLogger("mix_python_sdk"))You can also enable a default debug logger by setting an environment variable MIX_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.