CorePlexMLClient

The CorePlexMLClient is the entry point for all SDK operations. It initializes the HTTP transport and exposes every API resource as a typed attribute.

Constructor

CorePlexMLClient(base_url="http://localhost:8888", api_key=None, timeout=30)

Parameters

Parameter	Type	Default	Description
`base_url`	`str`	`"http://localhost:8888"`	CorePlexML server URL. Include the scheme (`https://`).
`api_key`	`str \| None`	`None`	API key for Bearer authentication. Generate one from the web UI.
`timeout`	`int`	`30`	HTTP request timeout in seconds.

Resource Attributes

Every resource is initialized once during client construction and is accessible as a read-only attribute.

Attribute	Type	Description
`projects`	`ProjectsResource`	Create, list, update, delete projects and manage members.
`datasets`	`DatasetsResource`	Upload, list, download datasets and inspect columns.
`experiments`	`ExperimentsResource`	Create AutoML experiments and poll for completion.
`models`	`ModelsResource`	List trained models, get details, and make predictions.
`deployments`	`DeploymentsResource`	Deploy models, make predictions, promote/rollback.
`reports`	`ReportsResource`	Generate and download PDF reports.
`privacy`	`PrivacyResource`	PII detection and data transformation.
`synthgen`	`SynthGenResource`	Train generative models and produce synthetic data.
`studio`	`StudioResource`	What-If Analysis – scenario-based model exploration.

Connection Configuration

The SDK uses the requests library internally. The base URL is normalized (trailing slashes are stripped), and the API key is sent as a Authorization: Bearer <key> header on every request.

# HTTPS with a long timeout for large uploads
client = CorePlexMLClient(
    base_url="https://ml.example.com",
    api_key="cp_ab12cd34.your-secret-key",
    timeout=120,
)

# Local development (no auth)
local_client = CorePlexMLClient()

Authentication

API keys are created in the CorePlexML web UI under Settings > API Keys. Each key has a prefix and a secret separated by a dot (e.g., cp_ab12cd34.your-secret-key). Keys are scoped to a user account and inherit that user’s project permissions.

If no api_key is provided, requests are sent without an Authorization header. This may work for unauthenticated local development endpoints but will fail against production servers.

from coreplexml import CorePlexMLClient, AuthenticationError

client = CorePlexMLClient(
    base_url="https://ml.example.com",
    api_key="cp_ab12cd34.your-secret-key",
)

try:
    client.projects.list()
except AuthenticationError:
    print("API key is invalid or expired. Generate a new one in Settings.")

Autodoc Reference

class coreplexml.CorePlexMLClient(base_url='http://localhost:8888', api_key=None, timeout=30)[source]

Bases: object

Top-level client for the CorePlexML Python SDK.

Provides access to all API resources through typed sub-clients.

Parameters:

base_url (str) – CorePlexML server URL (default http://localhost:8888).
api_key (Optional[str]) – Bearer token for API authentication.
timeout (int) – Request timeout in seconds (default 30).

Example:

from coreplexml import CorePlexMLClient

client = CorePlexMLClient("https://your-domain.com", api_key="your-key")
projects = client.projects.list()

projects: Manage projects.

datasets: Upload, list, and manage datasets.

experiments: Create and monitor AutoML experiments.

models: Get model info and make predictions.

deployments: Deploy models and manage production endpoints.

reports: Generate and download reports.

privacy: Privacy Suite – PII detection and data transformation.

synthgen: Synthetic data generation with CTGAN/CopulaGAN/TVAE/Gaussian Copula.

studio: What-If Analysis – scenario comparison.

__init__(base_url='http://localhost:8888', api_key=None, timeout=30)[source]

Initialize the CorePlexML client.

Parameters:

base_url (str) – Server URL (default http://localhost:8888).
api_key (Optional[str]) – API key for Bearer authentication.
timeout (int) – Request timeout in seconds.

close()[source]

Close the underlying HTTP session and release connections.

Return type:: None