Data Loading
curl --request POST \
--url 'https://api.example.com/data_loading?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"parameters": {},
"experiment_id": "",
"name": "",
"description": "",
"num_qubits": 500,
"distribution_name": "<string>",
"dl_type": ""
}
'import requests
url = "https://api.example.com/data_loading?HAIQU_API_KEY="
payload = {
"parameters": {},
"experiment_id": "",
"name": "",
"description": "",
"num_qubits": 500,
"distribution_name": "<string>",
"dl_type": ""
}
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({
parameters: {},
experiment_id: '',
name: '',
description: '',
num_qubits: 500,
distribution_name: '<string>',
dl_type: ''
})
};
fetch('https://api.example.com/data_loading?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/data_loading?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([
'parameters' => [
],
'experiment_id' => '',
'name' => '',
'description' => '',
'num_qubits' => 500,
'distribution_name' => '<string>',
'dl_type' => ''
]),
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/data_loading?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"parameters\": {},\n \"experiment_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"num_qubits\": 500,\n \"distribution_name\": \"<string>\",\n \"dl_type\": \"\"\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/data_loading?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"parameters\": {},\n \"experiment_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"num_qubits\": 500,\n \"distribution_name\": \"<string>\",\n \"dl_type\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/data_loading?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 \"parameters\": {},\n \"experiment_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"num_qubits\": 500,\n \"distribution_name\": \"<string>\",\n \"dl_type\": \"\"\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": {},
"num_qubits": 123,
"dl_type": "DistributionLoading",
"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,
"distribution_name": "<string>",
"circuit_id": "<string>",
"fidelity": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Data Loading
Data Loading endpoint.
Creates Data Loading job.
Args: user (User): User authenticated with api key. data (DataLoadingSubmitModel): The payload for data loading.
Returns: DataLoadingJobModel: The new job object.
POST
/
data_loading
Data Loading
curl --request POST \
--url 'https://api.example.com/data_loading?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"parameters": {},
"experiment_id": "",
"name": "",
"description": "",
"num_qubits": 500,
"distribution_name": "<string>",
"dl_type": ""
}
'import requests
url = "https://api.example.com/data_loading?HAIQU_API_KEY="
payload = {
"parameters": {},
"experiment_id": "",
"name": "",
"description": "",
"num_qubits": 500,
"distribution_name": "<string>",
"dl_type": ""
}
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({
parameters: {},
experiment_id: '',
name: '',
description: '',
num_qubits: 500,
distribution_name: '<string>',
dl_type: ''
})
};
fetch('https://api.example.com/data_loading?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/data_loading?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([
'parameters' => [
],
'experiment_id' => '',
'name' => '',
'description' => '',
'num_qubits' => 500,
'distribution_name' => '<string>',
'dl_type' => ''
]),
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/data_loading?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"parameters\": {},\n \"experiment_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"num_qubits\": 500,\n \"distribution_name\": \"<string>\",\n \"dl_type\": \"\"\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/data_loading?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"parameters\": {},\n \"experiment_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"num_qubits\": 500,\n \"distribution_name\": \"<string>\",\n \"dl_type\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/data_loading?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 \"parameters\": {},\n \"experiment_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"num_qubits\": 500,\n \"distribution_name\": \"<string>\",\n \"dl_type\": \"\"\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": {},
"num_qubits": 123,
"dl_type": "DistributionLoading",
"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,
"distribution_name": "<string>",
"circuit_id": "<string>",
"fidelity": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
APIKeyQueryAPIKeyHeader
Body
application/json
Data Loading payload data model.
Maximum string length:
200Maximum string length:
1024Size of the circuit to generate. Requested value only: the API replaces it with the real circuit size once the circuit exists. Left unset by the loaders that derive the size from their input (block vector, MPS).
Required range:
1 <= x <= 1000Response
Successful Response
Data Loading Job (running on Haiqu backend).
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 dl_type.
Available options:
DistributionLoading, MultivariateDistributionLoading, VectorLoading, BlockVectorLoading, EntangledManifoldEmbedding, MpsLoading, FunctionLoading, FourierLoading