List Circuits In Experiment

curl --request GET \
  --url 'https://api.example.com/ai/{experiment_id}/circuits?HAIQU_API_KEY='

[
  {
    "id": "<string>",
    "hash": "<string>",
    "name": "<string>",
    "creation_date": "2023-11-07T05:31:56Z",
    "user_id": 123,
    "experiment_id": "<string>",
    "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_qubits_active": 123,
      "num_parameters": 123,
      "other_gates": 123,
      "instructions_total": 123,
      "operations_counts": {},
      "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>"
    ]
  }
]

API Reference

List Circuits In Experiment

List experiment’s circuits for AI context.

The tool returns ContextCircuitModel objects, which are higher-level circuit entities for AI agents. They include circuit context/metadata and reference the underlying Qiskit QuantumCircuit representation. They are also more lightweight than returning full CircuitModel, which could have large QPY data.

The IDs of the circuits returned by this tool could be used in other tools:

compress_circuit_with_state_compression to compress the circuit with state compression technique.
run_circuits_on_qpu_or_simulator to run the circuit on the device.
list_jobs_for_circuit to get jobs related to the circuit and their results.
list_children_circuits to get transpiled or compressed versions of the circuit

Args: experiment_id: the ID of the parent experiment. user (UserModel): User authenticated with api key. circuit_ids (list[str] | None): When specified, filter out only specific circuits. job_type (str | None): When specified, filter out only circuits that belong to specific job type. Possible values are: “Analytics”, “Data Loading”, “Run”, “State Compression”, “Transpilation”, “Variational”, “Pretraining”, “SKQD”. limit (int): Limit the number of the circuits returned.

Returns: list: List of ContextCircuitModel objects.

GET

{experiment_id}

circuits

List Circuits In Experiment

curl --request GET \
  --url 'https://api.example.com/ai/{experiment_id}/circuits?HAIQU_API_KEY='

[
  {
    "id": "<string>",
    "hash": "<string>",
    "name": "<string>",
    "creation_date": "2023-11-07T05:31:56Z",
    "user_id": 123,
    "experiment_id": "<string>",
    "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_qubits_active": 123,
      "num_parameters": 123,
      "other_gates": 123,
      "instructions_total": 123,
      "operations_counts": {},
      "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

Path Parameters

experiment_id

string

required

Query Parameters

circuit_ids

string[] | null

job_type

string | null

limit

integer

default:100

Response

Successful Response

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:""

Documentation Index

Authorizations

Path Parameters

Query Parameters

Response