Flow
curl --request POST \
--url 'https://api.example.com/flow?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"program": {
"layers": [
{
"type": "input"
}
],
"schema_version": 1
},
"circuit_ids": [
"<string>"
],
"name": "",
"description": "",
"shots": 1000,
"parameters": [
"<unknown>"
],
"observables": [
[
[
[
"<string>"
],
[
123
]
]
]
],
"device_credentials": {},
"dry_run": false
}
'import requests
url = "https://api.example.com/flow?HAIQU_API_KEY="
payload = {
"experiment_id": "<string>",
"program": {
"layers": [{ "type": "input" }],
"schema_version": 1
},
"circuit_ids": ["<string>"],
"name": "",
"description": "",
"shots": 1000,
"parameters": ["<unknown>"],
"observables": [[[["<string>"], [123]]]],
"device_credentials": {},
"dry_run": False
}
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>',
program: {layers: [{type: 'input'}], schema_version: 1},
circuit_ids: ['<string>'],
name: '',
description: '',
shots: 1000,
parameters: ['<unknown>'],
observables: [[[['<string>'], [123]]]],
device_credentials: {},
dry_run: false
})
};
fetch('https://api.example.com/flow?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/flow?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>',
'program' => [
'layers' => [
[
'type' => 'input'
]
],
'schema_version' => 1
],
'circuit_ids' => [
'<string>'
],
'name' => '',
'description' => '',
'shots' => 1000,
'parameters' => [
'<unknown>'
],
'observables' => [
[
[
[
'<string>'
],
[
123
]
]
]
],
'device_credentials' => [
],
'dry_run' => false
]),
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/flow?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"program\": {\n \"layers\": [\n {\n \"type\": \"input\"\n }\n ],\n \"schema_version\": 1\n },\n \"circuit_ids\": [\n \"<string>\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"shots\": 1000,\n \"parameters\": [\n \"<unknown>\"\n ],\n \"observables\": [\n [\n [\n [\n \"<string>\"\n ],\n [\n 123\n ]\n ]\n ]\n ],\n \"device_credentials\": {},\n \"dry_run\": false\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/flow?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"program\": {\n \"layers\": [\n {\n \"type\": \"input\"\n }\n ],\n \"schema_version\": 1\n },\n \"circuit_ids\": [\n \"<string>\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"shots\": 1000,\n \"parameters\": [\n \"<unknown>\"\n ],\n \"observables\": [\n [\n [\n [\n \"<string>\"\n ],\n [\n 123\n ]\n ]\n ]\n ],\n \"device_credentials\": {},\n \"dry_run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/flow?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 \"program\": {\n \"layers\": [\n {\n \"type\": \"input\"\n }\n ],\n \"schema_version\": 1\n },\n \"circuit_ids\": [\n \"<string>\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"shots\": 1000,\n \"parameters\": [\n \"<unknown>\"\n ],\n \"observables\": [\n [\n [\n [\n \"<string>\"\n ],\n [\n 123\n ]\n ]\n ]\n ],\n \"device_credentials\": {},\n \"dry_run\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": 123,
"experiment_id": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"program": {
"layers": [
{
"type": "input"
}
],
"schema_version": 1
},
"input_circuit_ids": [
"<string>"
],
"shots": 123,
"dry_run": true,
"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,
"parameters": [
"<unknown>"
],
"observables": [
[
[
[
"<string>"
],
[
123
]
]
]
],
"quantum_results": [
"<unknown>"
],
"estimated_qpu_cost": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Flow
Flow (hybrid program execution) endpoint. Creates a job.
Args: user (User): User authenticated with api key. data (HybridSubmitModel): Hybrid job arguments. db: Database.
Returns: HybridJobModel: The new job object.
POST
/
flow
Flow
curl --request POST \
--url 'https://api.example.com/flow?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"program": {
"layers": [
{
"type": "input"
}
],
"schema_version": 1
},
"circuit_ids": [
"<string>"
],
"name": "",
"description": "",
"shots": 1000,
"parameters": [
"<unknown>"
],
"observables": [
[
[
[
"<string>"
],
[
123
]
]
]
],
"device_credentials": {},
"dry_run": false
}
'import requests
url = "https://api.example.com/flow?HAIQU_API_KEY="
payload = {
"experiment_id": "<string>",
"program": {
"layers": [{ "type": "input" }],
"schema_version": 1
},
"circuit_ids": ["<string>"],
"name": "",
"description": "",
"shots": 1000,
"parameters": ["<unknown>"],
"observables": [[[["<string>"], [123]]]],
"device_credentials": {},
"dry_run": False
}
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>',
program: {layers: [{type: 'input'}], schema_version: 1},
circuit_ids: ['<string>'],
name: '',
description: '',
shots: 1000,
parameters: ['<unknown>'],
observables: [[[['<string>'], [123]]]],
device_credentials: {},
dry_run: false
})
};
fetch('https://api.example.com/flow?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/flow?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>',
'program' => [
'layers' => [
[
'type' => 'input'
]
],
'schema_version' => 1
],
'circuit_ids' => [
'<string>'
],
'name' => '',
'description' => '',
'shots' => 1000,
'parameters' => [
'<unknown>'
],
'observables' => [
[
[
[
'<string>'
],
[
123
]
]
]
],
'device_credentials' => [
],
'dry_run' => false
]),
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/flow?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"program\": {\n \"layers\": [\n {\n \"type\": \"input\"\n }\n ],\n \"schema_version\": 1\n },\n \"circuit_ids\": [\n \"<string>\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"shots\": 1000,\n \"parameters\": [\n \"<unknown>\"\n ],\n \"observables\": [\n [\n [\n [\n \"<string>\"\n ],\n [\n 123\n ]\n ]\n ]\n ],\n \"device_credentials\": {},\n \"dry_run\": false\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/flow?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"program\": {\n \"layers\": [\n {\n \"type\": \"input\"\n }\n ],\n \"schema_version\": 1\n },\n \"circuit_ids\": [\n \"<string>\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"shots\": 1000,\n \"parameters\": [\n \"<unknown>\"\n ],\n \"observables\": [\n [\n [\n [\n \"<string>\"\n ],\n [\n 123\n ]\n ]\n ]\n ],\n \"device_credentials\": {},\n \"dry_run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/flow?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 \"program\": {\n \"layers\": [\n {\n \"type\": \"input\"\n }\n ],\n \"schema_version\": 1\n },\n \"circuit_ids\": [\n \"<string>\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"shots\": 1000,\n \"parameters\": [\n \"<unknown>\"\n ],\n \"observables\": [\n [\n [\n [\n \"<string>\"\n ],\n [\n 123\n ]\n ]\n ]\n ],\n \"device_credentials\": {},\n \"dry_run\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": 123,
"experiment_id": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"program": {
"layers": [
{
"type": "input"
}
],
"schema_version": 1
},
"input_circuit_ids": [
"<string>"
],
"shots": 123,
"dry_run": true,
"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,
"parameters": [
"<unknown>"
],
"observables": [
[
[
[
"<string>"
],
[
123
]
]
]
],
"quantum_results": [
"<unknown>"
],
"estimated_qpu_cost": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
APIKeyQueryAPIKeyHeader
Body
application/json
Hybrid submit payload data model.
Show child attributes
Show child attributes
Minimum array length:
1Required range:
x >= 1Show child attributes
Show child attributes
Response
Successful Response
Hybrid 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 Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I