from mixtrain import MixClientMixClient handles authentication and provides low-level API access. For most operations, use the SDK classes (Model, Dataset, Workflow, Eval, Router) which provide a simpler interface.
Constructor
MixClient(
api_key: str = None,
workspace_name: str = None
)| Parameter | Type | Description |
|---|---|---|
api_key | str | API key (defaults to MIXTRAIN_API_KEY env var) |
workspace_name | str | Workspace name (defaults to configured workspace) |
# Auto-detect from environment
client = MixClient()
# Explicit API key
client = MixClient(api_key="mix-your-api-key")
# Specific workspace
client = MixClient(workspace_name="production")Properties
| Property | Type | Description |
|---|---|---|
workspace_name | str | Current workspace |
auth_method | str | "API_KEY" or "LOGIN_TOKEN" |
platform_url | str | API base URL |
Authentication Methods
Environment Variable
import os
os.environ['MIXTRAIN_API_KEY'] = 'mix-your-api-key'
client = MixClient()Interactive Login
mixtrain loginclient = MixClient() # Uses saved login tokenModel Methods
list_models()
client.list_models() -> list[dict]run_model()
client.run_model(name: str, inputs: dict, config: dict = None) -> dictcreate_model()
client.create_model(name: str, code: str, description: str = None) -> dictDataset Methods
list_datasets()
client.list_datasets() -> list[dict]get_dataset()
client.get_dataset(name: str) -> dictcreate_dataset()
client.create_dataset(name: str, file_path: str, description: str = None) -> dictWorkflow Methods
list_workflows()
client.list_workflows() -> list[dict]run_workflow()
client.run_workflow(name: str, config: dict = None) -> dictSecret Methods
get_secret()
client.get_secret(name: str) -> str| Parameter | Type | Description |
|---|---|---|
name | str | Secret name |
Returns: str secret value
get_all_secrets()
client.get_all_secrets() -> list[dict]Returns: list[dict] with secret metadata (not values)
Workspace Methods
list_workspaces()
client.list_workspaces() -> list[dict]create_workspace()
client.create_workspace(name: str, description: str = None) -> dictdelete_workspace()
client.delete_workspace(name: str) -> NoneProvider Methods
list_model_providers()
client.list_model_providers() -> list[dict]list_dataset_providers()
client.list_dataset_providers() -> list[dict]create_model_provider()
client.create_model_provider(provider_type: str, secrets: dict) -> dictcreate_dataset_provider()
client.create_dataset_provider(provider_type: str, secrets: dict) -> dictupdate_model_provider()
client.update_model_provider(provider_id: str, secrets: dict) -> dictdelete_model_provider()
client.delete_model_provider(provider_id: str) -> None