Skip to main content
POST
Load Classical Data With Data Loading

Authorizations

HAIQU_API_KEY
string
query
required

Body

application/json

Define payload for MCP classical-to-quantum data loading jobs.

MCP-layer validation is limited to mode-specific required-key checks plus the BlockVectorLoading exclusivity rule implemented by :func:haiqu.api.mcp.data_loading.validation.validate_data_loading_payload.

Attributes: experiment_id: Parent experiment identifier for the data-loading job. name: Optional job name. dl_type: Data-loading mode selector. parameters: Mode-specific parameters forwarded to the backend. num_qubits: Optional qubit count. Required for DistributionLoading, MultivariateDistributionLoading and FunctionLoading. distribution_name: Distribution identifier required for DistributionLoading (1D) and MultivariateDistributionLoading (2D distribution or copula).

parameters
Parameters · object
required

Mode-specific parameters. For DistributionLoading (1D scipy.stats distributions): distribution_name, num_qubits, interval_start, interval_end, loc, scale, num_layers, truncation_cutoff (+ optional scipy distribution shape args). For MultivariateDistributionLoading (2D distributions and copulas): interval (a [start, end] pair shared by both dimensions or a nested [[x_start, x_end], [y_start, y_end]] pair), encoding (probability or amplitude), num_layers, truncation_cutoff, plus distribution_params for direct 2D distributions, or copula_params, marginal_distribution_names, marginal_distribution_params (two entries each) for copulas; optional fine_tuning_iterations and max_time (seconds). For VectorLoading: data, num_layers, truncation_cutoff, fine_tuning_iterations. For BlockVectorLoading: data, (num_blocks or target_num_qubits), num_layers, truncation_cutoff, fine_tuning_iterations. For EntangledManifoldEmbedding: data, density, real, periodicity, num_layers, truncation_cutoff, fine_tuning_iterations. For MpsLoading: mps, shape, num_layers, truncation_cutoff, fine_tuning_iterations. For FunctionLoading: func (math expression string in the single variable x, e.g. exp(-x**2)), interval_start, interval_end, num_layers, truncation_cutoff, fine_tuning_iterations. For FourierLoading: fourier_coefficients (nested list, ascending in frequency along every axis with no fftshift applied) is the only required key. Optional: num_qubits and min_freqs (an integer shared by all dimensions or one entry per dimension), long_range (default false), num_layers (default 2), truncation_cutoff (default 1e-6), fine_tuning_iterations (default 20).

dl_type
enum<string>
required

Data loading mode. Use one of: DistributionLoading, MultivariateDistributionLoading, VectorLoading, BlockVectorLoading, EntangledManifoldEmbedding, MpsLoading, FunctionLoading, FourierLoading.

Available options:
DistributionLoading,
MultivariateDistributionLoading,
VectorLoading,
BlockVectorLoading,
EntangledManifoldEmbedding,
MpsLoading,
FunctionLoading,
FourierLoading
experiment_id
string | null
default:""
name
string | null
default:""
description
string | null
default:""
Maximum string length: 1024
num_qubits
integer | null

Optional qubit count. Required for DistributionLoading, FunctionLoading and MultivariateDistributionLoading (where it is split between the two dimensions); optional for VectorLoading and EntangledManifoldEmbedding; ignored for BlockVectorLoading. Also ignored for FourierLoading, which takes its per-dimension output width from parameters.num_qubits.

distribution_name
string | null

Required for DistributionLoading (a 1D scipy.stats distribution, e.g. norm, uniform, beta) and for MultivariateDistributionLoading (a 2D distribution or copula: bivariate_student_t, bivariate_gamma, bivariate_von_mises, marshall_olkin_weibull, bivariate_poisson_normal_approx, gaussian_copula, clayton_copula, gumbel_copula, frank_copula).

Response

Successful Response

Represent context payload returned after data-loading submission.

Attributes: context: Submission summary text including the created job ID and next polling step. This response model does not expose structured job_id or output circuit_id fields outside the text.

context
string
required