Compression
curl --request POST \
--url 'https://api.example.com/compression?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"parameters": {},
"circuit_ids": [],
"compression_type": "StateCompression"
}
'import requests
url = "https://api.example.com/compression?HAIQU_API_KEY="
payload = {
"experiment_id": "<string>",
"parameters": {},
"circuit_ids": [],
"compression_type": "StateCompression"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
experiment_id: '<string>',
parameters: {},
circuit_ids: [],
compression_type: 'StateCompression'
})
};
fetch('https://api.example.com/compression?HAIQU_API_KEY=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/compression?HAIQU_API_KEY=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'experiment_id' => '<string>',
'parameters' => [
],
'circuit_ids' => [
],
'compression_type' => 'StateCompression'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/compression?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"parameters\": {},\n \"circuit_ids\": [],\n \"compression_type\": \"StateCompression\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/compression?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"parameters\": {},\n \"circuit_ids\": [],\n \"compression_type\": \"StateCompression\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/compression?HAIQU_API_KEY=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"experiment_id\": \"<string>\",\n \"parameters\": {},\n \"circuit_ids\": [],\n \"compression_type\": \"StateCompression\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"user_id": 123,
"experiment_id": "<string>",
"status": "Submitted",
"job_type": "User local job",
"creation_date": "2023-11-07T05:31:56Z",
"parameters": {},
"compression_type": "StateCompression",
"name": "<string>",
"description": "<string>",
"device_id": "Haiqu OS",
"run_date": "2023-11-07T05:31:56Z",
"finish_date": "2023-11-07T05:31:56Z",
"logs": "<string>",
"quality": 123,
"info": {},
"time": 123,
"circuit_id": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Compression
Haiqu’s state compression endpoint.
Haiqu’s state compression is an approximate fixed-input-state compilation method to extend the effective depth of circuits that can be executed on noisy hardware. It features several tunable parameters to adjust the trade-off between compression level and circuit quality, allowing the user to tailor the compression to the circuit and device noise characteristics.
Args: user (User): User authenticated with api key. data (StateCompressionSubmitModel): The payload for the function.
Returns: list[StateCompressionJobModel]: The new job objects.
POST
/
compression
Compression
curl --request POST \
--url 'https://api.example.com/compression?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"parameters": {},
"circuit_ids": [],
"compression_type": "StateCompression"
}
'import requests
url = "https://api.example.com/compression?HAIQU_API_KEY="
payload = {
"experiment_id": "<string>",
"parameters": {},
"circuit_ids": [],
"compression_type": "StateCompression"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
experiment_id: '<string>',
parameters: {},
circuit_ids: [],
compression_type: 'StateCompression'
})
};
fetch('https://api.example.com/compression?HAIQU_API_KEY=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/compression?HAIQU_API_KEY=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'experiment_id' => '<string>',
'parameters' => [
],
'circuit_ids' => [
],
'compression_type' => 'StateCompression'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/compression?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"parameters\": {},\n \"circuit_ids\": [],\n \"compression_type\": \"StateCompression\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/compression?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"parameters\": {},\n \"circuit_ids\": [],\n \"compression_type\": \"StateCompression\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/compression?HAIQU_API_KEY=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"experiment_id\": \"<string>\",\n \"parameters\": {},\n \"circuit_ids\": [],\n \"compression_type\": \"StateCompression\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"user_id": 123,
"experiment_id": "<string>",
"status": "Submitted",
"job_type": "User local job",
"creation_date": "2023-11-07T05:31:56Z",
"parameters": {},
"compression_type": "StateCompression",
"name": "<string>",
"description": "<string>",
"device_id": "Haiqu OS",
"run_date": "2023-11-07T05:31:56Z",
"finish_date": "2023-11-07T05:31:56Z",
"logs": "<string>",
"quality": 123,
"info": {},
"time": 123,
"circuit_id": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
APIKeyQueryAPIKeyHeader
Body
application/json
Response
Successful Response
Class for job status.
Available options:
Submitted, Initializing, Queued, Validating, Running, Cancelled, Done, Error Class for job types.
Available options:
User local job, Analytics, Device specific analytics, Data Loading, Hybrid, Run, State Compression, Transpilation, Variational, Pretraining, SKQD Class for compression_type.
Available options:
StateCompression, StateCompression2D, Su2EquivariantCompilation