Skip to main content
POST
/
ai
/
submit_circuit_for_analytics
Submit Circuit For Analytics
curl --request POST \
  --url 'https://api.example.com/ai/submit_circuit_for_analytics?HAIQU_API_KEY=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "experiment_id": "<string>",
  "circuit_qasm": "<string>",
  "name": "<string>",
  "context": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "hash": "<string>",
  "name": "<string>",
  "creation_date": "2023-11-07T05:31:56Z",
  "user_id": 123,
  "experiment_id": "<string>",
  "status": "Submitted",
  "generated": true,
  "context": "<string>",
  "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>"
  ]
}

Authorizations

HAIQU_API_KEY
string
query
required

Body

application/json

Circuit submit payload data model.

experiment_id
string
required

ID of the experiment to which the circuit belongs.

circuit_qasm
string
required

Quantum circuit in QASM 2.0 or 3.0 format.

name
string
required

The name of the circuit.

context
string
required

Short explanation of why this circuit is being created.

description
string | null

The description of the circuit.

Response

Successful Response

Circuit model with the context for AI/MCP endpoints.

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
context
string
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