# Haiqu Documentation

## Docs

- [Backpropagate Observables](https://docs.haiqu.ai/api-reference/backpropagate-observables.md): Submit a job to backpropagate observables through the circuit.
- [Build Lr Qaoa Circuit](https://docs.haiqu.ai/api-reference/build-lr-qaoa-circuit.md): Build an LR-QAOA circuit for a QUBO problem (synchronous).
- [Cancel Job](https://docs.haiqu.ai/api-reference/cancel-job.md): Unified endpoint to cancel different types of the jobs.
- [Compress Circuit With State Compression](https://docs.haiqu.ai/api-reference/compress-circuit-with-state-compression.md): Submit a quantum circuit compression job using state compression.
- [Compute Analytics](https://docs.haiqu.ai/api-reference/compute-analytics.md): Explicitly fire the job to compute analytics on the backend.
- [Create Experiment](https://docs.haiqu.ai/api-reference/create-experiment.md): Create experiment endpoint.
- [Create New Experiment](https://docs.haiqu.ai/api-reference/create-new-experiment.md): Create a new experiment tool. If experiment with the same name already exists, return it.
- [Data Loading](https://docs.haiqu.ai/api-reference/data-loading.md): Data Loading endpoint.
- [Data Loading Estimates](https://docs.haiqu.ai/api-reference/data-loading-estimates.md): Data Loading estimates endpoint.
- [Delete Circuit](https://docs.haiqu.ai/api-reference/delete-circuit.md): Delete circuit.
- [Delete Experiment](https://docs.haiqu.ai/api-reference/delete-experiment.md): Delete experiment action endpoint.
- [Get Analytics](https://docs.haiqu.ai/api-reference/get-analytics.md): Get circuit analytics.
- [Get Artifact Content In Experiment](https://docs.haiqu.ai/api-reference/get-artifact-content-in-experiment.md): Return raw bytes for a base64-backed artifact over plain HTTP.
- [Get Artifact In Experiment](https://docs.haiqu.ai/api-reference/get-artifact-in-experiment.md): This tool is used to return the artifact from the experiment.
- [Get Benchmarks](https://docs.haiqu.ai/api-reference/get-benchmarks.md): Get data for benchmarks for key circuit metrics against references.
- [Get Circuit](https://docs.haiqu.ai/api-reference/get-circuit.md): Get circuit by ID.
- [Get Circuit By Hash](https://docs.haiqu.ai/api-reference/get-circuit-by-hash.md): Get circuit by HASH.
- [Get Device Endpoint](https://docs.haiqu.ai/api-reference/get-device-endpoint.md): Get device endpoint.
- [Get Device Gate Map](https://docs.haiqu.ai/api-reference/get-device-gate-map.md): Get data for device visualization.
- [Get Experiment](https://docs.haiqu.ai/api-reference/get-experiment.md): Get experiment endpoint.
- [Get Experiment](https://docs.haiqu.ai/api-reference/get-experiment-1.md): Get experiment by ID tool.
- [Get Experiment By Name](https://docs.haiqu.ai/api-reference/get-experiment-by-name.md): Get experiment by name tool.
- [Get Job](https://docs.haiqu.ai/api-reference/get-job.md): Unified endpoint to get different types of the jobs.
- [Get Job Results And Status](https://docs.haiqu.ai/api-reference/get-job-results-and-status.md): This tool is used to get the job results and status of the execution.
- [Get Local Job By Hash](https://docs.haiqu.ai/api-reference/get-local-job-by-hash.md): Get local job by HASH endpoint.
- [Get Metrics Evolution](https://docs.haiqu.ai/api-reference/get-metrics-evolution.md): Get data for metrics evolution.
- [Get User](https://docs.haiqu.ai/api-reference/get-user.md): Get user profile endpoint.
- [Health Live](https://docs.haiqu.ai/api-reference/health-live.md): Used by the AI client to get health status of the MCP service.
- [Health Ready](https://docs.haiqu.ai/api-reference/health-ready.md): Used by the AI client to know that MCP server is ready to accept connection.
- [Hemistich](https://docs.haiqu.ai/api-reference/hemistich.md): Hemistich (state compression) endpoint.
- [Hemistich Estimates](https://docs.haiqu.ai/api-reference/hemistich-estimates.md): Hemistich estimates endpoint.
- [List Artifacts In Experiment](https://docs.haiqu.ai/api-reference/list-artifacts-in-experiment.md): This tool is used to list the artifacts for the experiment for AI context.
- [List Children Circuits](https://docs.haiqu.ai/api-reference/list-children-circuits.md): This tool is used to get the circuit's children, normally from `transpiled_circuit_ids` and `compressed_circuit_ids` fields.
- [List Circuits](https://docs.haiqu.ai/api-reference/list-circuits.md): List experiment's circuits endpoint.
- [List Circuits](https://docs.haiqu.ai/api-reference/list-circuits-1.md): List experiment's circuits for AI context.
- [List Devices Endpoint](https://docs.haiqu.ai/api-reference/list-devices-endpoint.md): List devices endpoint.
- [List Experiments](https://docs.haiqu.ai/api-reference/list-experiments.md): List user's experiments endpoint.
- [List Experiments Mcp](https://docs.haiqu.ai/api-reference/list-experiments-mcp.md): List user's experiments tool. The experiment model represents the quantum experiment, which is a container for circuits, jobs, and metrics.
- [List Jobs](https://docs.haiqu.ai/api-reference/list-jobs.md): List the jobs for the experiment or the circuit.
- [List Jobs](https://docs.haiqu.ai/api-reference/list-jobs-1.md): This tool is used to list the experiment's jobs for AI context. Job model represents the execution of a circuit(s) on a quantum device or simulator, and contains the results and metadata of the execution.
- [List Jobs For Circuit](https://docs.haiqu.ai/api-reference/list-jobs-for-circuit.md): This tool is used to get the circuit's related jobs, e.g. jobs where this circuit was used as an input or where the circuit was compressed, generated or transpiled.
- [List Qpus And Simulators](https://docs.haiqu.ai/api-reference/list-qpus-and-simulators.md): List available quantum devices and simulators.
- [Load Classical Data With Data Loading](https://docs.haiqu.ai/api-reference/load-classical-data-with-data-loading.md): Submit a data loading job with MCP-friendly context.
- [Log Artifact In Experiment](https://docs.haiqu.ai/api-reference/log-artifact-in-experiment.md): This tool is used to log the artifact in the experiment.
- [Mcp Meta](https://docs.haiqu.ai/api-reference/mcp-meta.md): Used by the AI client to understand if process is changed (happens after reload/restart of the server). So the API chat will keep context and reestablish connection.
- [Post Metrics](https://docs.haiqu.ai/api-reference/post-metrics.md): Post user-defined metrics data for the circuit.
- [Post Metrics](https://docs.haiqu.ai/api-reference/post-metrics-1.md): Post metrics data for experiment.
- [Post Metrics](https://docs.haiqu.ai/api-reference/post-metrics-2.md): Post metrics data for circuit.
- [Postprocess Counts](https://docs.haiqu.ai/api-reference/postprocess-counts.md): Apply post-processing to quantum measurement counts.
- [Postprocess Skqd](https://docs.haiqu.ai/api-reference/postprocess-skqd.md): Submit an SKQD postprocessing job (async worker).
- [Pretraining](https://docs.haiqu.ai/api-reference/pretraining.md): Pretraining endpoint. Creates a pretraining job.
- [Root](https://docs.haiqu.ai/api-reference/root.md): Root endpoint of the API.
- [Run](https://docs.haiqu.ai/api-reference/run.md): Run endpoint. Creates a job.
- [Run Circuits On Qpu Or Simulator](https://docs.haiqu.ai/api-reference/run-circuits-on-qpu-or-simulator.md): Run one or more circuits on a quantum device or simulator.
- [Submit Circuit](https://docs.haiqu.ai/api-reference/submit-circuit.md): Create circuit endpoint.
- [Submit Circuit For Analytics](https://docs.haiqu.ai/api-reference/submit-circuit-for-analytics.md): Submit a quantum circuit defined by QASM string and compute its core metrics. A bunch of useful analytics are computed for the circuit and stored in the database, such as qubits, depth, depth_2q, gates_1q, gates_2q, gates_total, etc.
- [Submit Local Job](https://docs.haiqu.ai/api-reference/submit-local-job.md): Submit user-run job (user executed on it's own) endpoint.
- [Transpile Circuit](https://docs.haiqu.ai/api-reference/transpile-circuit.md): Transpile a circuit to a given device.
- [Update Experiment](https://docs.haiqu.ai/api-reference/update-experiment.md): Update an existing experiment endpoint.
- [Update Experiment](https://docs.haiqu.ai/api-reference/update-experiment-1.md): Update an existing experiment tool. Only `name` and `description` can be updated.
- [Variational](https://docs.haiqu.ai/api-reference/variational.md): Variational optimization endpoint. Creates a variational job.
- [Version](https://docs.haiqu.ai/api-reference/version.md): Version endpoint of the API.
- [Data sheet](https://docs.haiqu.ai/benchmarks/datasheet.md): Specifications and benchmarks of core functions
- [Changelog](https://docs.haiqu.ai/changelog.md): Product updates and announcements
- [Circuit Analytics](https://docs.haiqu.ai/core_features/circ_analytics.md): Analyze your circuits with Haiqu SDK
- [Compression](https://docs.haiqu.ai/core_features/compression.md): Record-breaking circuit depth reduction at utility scale.
- [Distribution Loading](https://docs.haiqu.ai/core_features/data_loading_dist.md): Load distributions with compact circuits
- [Isometry Encoding](https://docs.haiqu.ai/core_features/data_loading_isom.md): Loads classical data into compact quantum circuits.
- [Data Loading](https://docs.haiqu.ai/core_features/data_loading_vect.md): Load custom data into compact quantum circuits
- [Error Mitigation](https://docs.haiqu.ai/core_features/error_shield.md): Mitigating the effects of the noise in your workloads
- [Experiment Tracking](https://docs.haiqu.ai/core_features/exp_tracking.md): Organize, track, and manage your quantum experiments, circuits, and jobs in Haiqu SDK
- [Optimization & Postprocessing](https://docs.haiqu.ai/core_features/postprocessing.md): Classical enhancement of your quantum optimization for the best performance.
- [Variational algorithms](https://docs.haiqu.ai/core_features/qml.md): Execute variational quantum algorithms
- [Transpilation](https://docs.haiqu.ai/core_features/transpilation.md): Transpiling the circuits to different devices and comparing transpilations
- [](https://docs.haiqu.ai/index.md)
- [Amazon Braket](https://docs.haiqu.ai/integrations/amazon.md): Explore different hardware modalities and providers by running on AWS Braket devices
- [IBM Quantum](https://docs.haiqu.ai/integrations/ibm.md): Seamless Access to Quantum Processing Units by IBM.
- [IonQ Cloud](https://docs.haiqu.ai/integrations/ionq.md): Access to the trapped ion devices via IonQ Cloud.
- [Publications](https://docs.haiqu.ai/publications.md)
- [AI Assisted Development](https://docs.haiqu.ai/quickstart/ai-assisted-development.md)
- [Get Started](https://docs.haiqu.ai/quickstart/qs_intro.md): Get up and running with Haiqu SDK in under 5 minutes
- [Local Installation](https://docs.haiqu.ai/quickstart/qs_local.md): Get up and running with Haiqu SDK in under 5 minutes
- [Update the SDK](https://docs.haiqu.ai/quickstart/update-the-sdk.md): Get the latest Haiqu SDK with the most powerful features
- [Draw](https://docs.haiqu.ai/reference/core/draw.md)
- [Get Circuits and Jobs](https://docs.haiqu.ai/reference/core/get.md)
- [Init Experiment](https://docs.haiqu.ai/reference/core/init.md)
- [List Objects](https://docs.haiqu.ai/reference/core/list.md)
- [Log Objects](https://docs.haiqu.ai/reference/core/log.md)
- [Login](https://docs.haiqu.ai/reference/core/login.md)
- [Block-wise Vector Loading](https://docs.haiqu.ai/reference/data/block_vector.md)
- [Distribution Loading](https://docs.haiqu.ai/reference/data/distribution.md)
- [Vector Loading](https://docs.haiqu.ai/reference/data/vector.md)
- [Compression](https://docs.haiqu.ai/reference/middleware/compression.md)
- [Postprocessing](https://docs.haiqu.ai/reference/optimization/postprocessing.md): Techniques for postprocessing optimization results.
- [Problem Formulations](https://docs.haiqu.ai/reference/optimization/problem.md): Different problem formulations for optimization problems.
- [Variational Quantum Optimization](https://docs.haiqu.ai/reference/qml/variational.md): Variational quantum optimization using the NFT optimizer.
- [Run](https://docs.haiqu.ai/reference/run/run.md)
- [Statevector Run](https://docs.haiqu.ai/reference/run/statevector_run.md)
- [Transpile](https://docs.haiqu.ai/reference/run/transpile.md)

## OpenAPI Specs

- [openapi](https://api.haiqu.ai/openapi.json)