Skip to main content
POST
/
circuits
Submit Circuit
curl --request POST \
  --url 'https://api.example.com/circuits?HAIQU_API_KEY=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "experiment_id": "<string>",
  "qpy_dump": "<string>",
  "hash": "<string>",
  "name": "",
  "description": "",
  "tags": "",
  "metrics": {}
}
'
{
  "id": "<string>",
  "hash": "<string>",
  "name": "<string>",
  "creation_date": "2023-11-07T05:31:56Z",
  "user_id": 123,
  "experiment_id": "<string>",
  "status": "Submitted",
  "generated": true,
  "description": "",
  "tags": "",
  "parameters": {},
  "analytics": {
    "qubits": 123,
    "depth": 123,
    "depth_2q": 123,
    "gates_1q": 123,
    "gates_2q": 123,
    "gates_total": 123,
    "other_ops": 123,
    "num_parameters": 123,
    "other_gates": 123,
    "instructions_total": 123,
    "gate_size_distribution": {},
    "gate_diversity": {},
    "gate_diversity_basis_gates": {},
    "gate_count_distribution": {},
    "program_communication": "N/A",
    "critical_depth": "N/A",
    "entanglement_ratio": "N/A",
    "parallelism": "N/A",
    "liveness_per_qubit": "N/A",
    "liveness": "N/A",
    "correlation_matrix": {},
    "kl_divergence": "N/A",
    "circuit_normalized": "<string>"
  },
  "transpilation_target": "<string>",
  "transpilation_options": {},
  "transpiled_circuit_ids": [
    "<string>"
  ],
  "compressed_circuit_ids": [
    "<string>"
  ],
  "job_ids": [
    "<string>"
  ],
  "qpy": "<string>",
  "evolution": {
    "metrics": [
      "<unknown>"
    ],
    "kl_divergence": [
      "<unknown>"
    ],
    "reality_check": [
      "<unknown>"
    ]
  },
  "metrics": {}
}

Authorizations

HAIQU_API_KEY
string
query
required

Body

application/json

Circuit submit payload data model.

experiment_id
string
required
qpy_dump
string
required
hash
string
required
name
string | null
default:""
description
string | null
default:""
tags
string | null
default:""
metrics
Metrics · object

Response

Successful Response

Haiqu Circuit model for Analytics Workflows.

Haiqu circuit is a quantum circuit logged in the Haiqu cloud or generated by Haiqu tools and enriched with analytics data. It wraps Qiskit QuantumCircuit (qpy property, in the form of QPY dump) and provides additional methods for analytics and visualization.

Note: that generated circuits (e.g. from data loading or state compression) have the QPY dump available only on the Haiqu cloud, but they can be still converted to regular Qiskit gates and used in other circuits or for execution.

id
string
required
hash
string
required
name
string
required
creation_date
string<date-time>
required
user_id
integer
required
experiment_id
string
required
status
enum<string>
required

Class for circuit analytics calculation job status.

Available options:
Submitted,
Running analytics computation,
Core metrics computation is done,
Advanced metrics computation is done,
Evolution computation is done,
Done,
Error
generated
boolean
required
description
string | null
default:""
tags
string | null
default:""
parameters
Parameters · object
analytics
CircuitAnalyticsModel · object

Data model for circuit metrics.

transpilation_target
string | null
transpilation_options
Transpilation Options · object
transpiled_circuit_ids
string[] | null
compressed_circuit_ids
string[] | null
job_ids
string[] | null
qpy
string | null
evolution
CircuitEvolutionModel · object

Data model for circuit evolution.

metrics
Metrics · object