Transpile Circuit
curl --request POST \
--url 'https://api.example.com/circuits/transpile?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"device_id": "<string>",
"circuit_ids": [],
"transpilation_options": {
"approximation_degree": 1,
"qubits_initially_zero": true
},
"seed_transpiler": 123,
"use_fractional_gates": false,
"name": "",
"description": ""
}
'import requests
url = "https://api.example.com/circuits/transpile?HAIQU_API_KEY="
payload = {
"experiment_id": "<string>",
"device_id": "<string>",
"circuit_ids": [],
"transpilation_options": {
"approximation_degree": 1,
"qubits_initially_zero": True
},
"seed_transpiler": 123,
"use_fractional_gates": False,
"name": "",
"description": ""
}
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>',
device_id: '<string>',
circuit_ids: [],
transpilation_options: {approximation_degree: 1, qubits_initially_zero: true},
seed_transpiler: 123,
use_fractional_gates: false,
name: '',
description: ''
})
};
fetch('https://api.example.com/circuits/transpile?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/circuits/transpile?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>',
'device_id' => '<string>',
'circuit_ids' => [
],
'transpilation_options' => [
'approximation_degree' => 1,
'qubits_initially_zero' => true
],
'seed_transpiler' => 123,
'use_fractional_gates' => false,
'name' => '',
'description' => ''
]),
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/circuits/transpile?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"device_id\": \"<string>\",\n \"circuit_ids\": [],\n \"transpilation_options\": {\n \"approximation_degree\": 1,\n \"qubits_initially_zero\": true\n },\n \"seed_transpiler\": 123,\n \"use_fractional_gates\": false,\n \"name\": \"\",\n \"description\": \"\"\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/circuits/transpile?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"device_id\": \"<string>\",\n \"circuit_ids\": [],\n \"transpilation_options\": {\n \"approximation_degree\": 1,\n \"qubits_initially_zero\": true\n },\n \"seed_transpiler\": 123,\n \"use_fractional_gates\": false,\n \"name\": \"\",\n \"description\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/circuits/transpile?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 \"device_id\": \"<string>\",\n \"circuit_ids\": [],\n \"transpilation_options\": {\n \"approximation_degree\": 1,\n \"qubits_initially_zero\": true\n },\n \"seed_transpiler\": 123,\n \"use_fractional_gates\": false,\n \"name\": \"\",\n \"description\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": 123,
"experiment_id": "<string>",
"status": "Submitted",
"job_type": "User local job",
"device_id": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"circuit_ids": [
"<unknown>"
],
"transpilation_options": {},
"name": "<string>",
"description": "<string>",
"run_date": "2023-11-07T05:31:56Z",
"finish_date": "2023-11-07T05:31:56Z",
"logs": "<string>",
"quality": 123,
"info": {},
"time": 123,
"parameters": {},
"use_fractional_gates": false,
"transpiled_circuit_ids": [
"<unknown>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Transpile Circuit
Transpile a circuit to a given device.
Args: user (User): User authenticated with api key. data (SubmitTranspilationModel): Transpilation options. db (Session): The database session.
Returns: TranspilationJobModel: The new job object.
POST
/
circuits
/
transpile
Transpile Circuit
curl --request POST \
--url 'https://api.example.com/circuits/transpile?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"device_id": "<string>",
"circuit_ids": [],
"transpilation_options": {
"approximation_degree": 1,
"qubits_initially_zero": true
},
"seed_transpiler": 123,
"use_fractional_gates": false,
"name": "",
"description": ""
}
'import requests
url = "https://api.example.com/circuits/transpile?HAIQU_API_KEY="
payload = {
"experiment_id": "<string>",
"device_id": "<string>",
"circuit_ids": [],
"transpilation_options": {
"approximation_degree": 1,
"qubits_initially_zero": True
},
"seed_transpiler": 123,
"use_fractional_gates": False,
"name": "",
"description": ""
}
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>',
device_id: '<string>',
circuit_ids: [],
transpilation_options: {approximation_degree: 1, qubits_initially_zero: true},
seed_transpiler: 123,
use_fractional_gates: false,
name: '',
description: ''
})
};
fetch('https://api.example.com/circuits/transpile?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/circuits/transpile?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>',
'device_id' => '<string>',
'circuit_ids' => [
],
'transpilation_options' => [
'approximation_degree' => 1,
'qubits_initially_zero' => true
],
'seed_transpiler' => 123,
'use_fractional_gates' => false,
'name' => '',
'description' => ''
]),
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/circuits/transpile?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"device_id\": \"<string>\",\n \"circuit_ids\": [],\n \"transpilation_options\": {\n \"approximation_degree\": 1,\n \"qubits_initially_zero\": true\n },\n \"seed_transpiler\": 123,\n \"use_fractional_gates\": false,\n \"name\": \"\",\n \"description\": \"\"\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/circuits/transpile?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"device_id\": \"<string>\",\n \"circuit_ids\": [],\n \"transpilation_options\": {\n \"approximation_degree\": 1,\n \"qubits_initially_zero\": true\n },\n \"seed_transpiler\": 123,\n \"use_fractional_gates\": false,\n \"name\": \"\",\n \"description\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/circuits/transpile?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 \"device_id\": \"<string>\",\n \"circuit_ids\": [],\n \"transpilation_options\": {\n \"approximation_degree\": 1,\n \"qubits_initially_zero\": true\n },\n \"seed_transpiler\": 123,\n \"use_fractional_gates\": false,\n \"name\": \"\",\n \"description\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": 123,
"experiment_id": "<string>",
"status": "Submitted",
"job_type": "User local job",
"device_id": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"circuit_ids": [
"<unknown>"
],
"transpilation_options": {},
"name": "<string>",
"description": "<string>",
"run_date": "2023-11-07T05:31:56Z",
"finish_date": "2023-11-07T05:31:56Z",
"logs": "<string>",
"quality": 123,
"info": {},
"time": 123,
"parameters": {},
"use_fractional_gates": false,
"transpiled_circuit_ids": [
"<unknown>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
APIKeyQueryAPIKeyHeader
Body
application/json
Data model for transpilation submit request
Maximum string length:
200Options to customize transpilation.
Show child attributes
Show child attributes
Maximum string length:
200Maximum string length:
1024Response
Successful Response
Job model for transpilation jobs.
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