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 circuits that belong to an experiment.

Use this tool when the caller wants to inspect or choose circuits inside one experiment before submitting runs, compression jobs, or follow-up job lookups. Returned circuit.id values are valid inputs for execution, compression, and circuit-job MCP tools.

When to Use:

Call this when the caller already has an experiment_id and needs candidate circuits for execution, compression, or further analysis.
Call this before list_jobs_for_circuit when the relevant circuit has not yet been selected.

Constraints:

limit controls the maximum number of rows returned.
Circuit IDs returned here should be forwarded unchanged into later MCP calls.

Notes:

Keep limit reasonably small for model-facing workflows because circuit objects can include analytics and metadata.
For agent-facing output, summarize the count and top candidates before expanding full records.

Args: experiment_id: Parent experiment identifier. user: Authenticated user resolved from the API key. db: Active database session. 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: Maximum number of circuits to return. Defaults to 100.

Returns: A list of circuit objects capped by limit.

Raises: HTTPException: Raised with 404 when the experiment is not available to the caller.

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