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

Submit Circuit For Analytics

Submit a QASM circuit and persist core analytics for MCP workflows.

Use this tool when the caller has experiment_id plus circuit_qasm and needs a persisted circuit before running, compressing, transpiling, or inspecting related jobs. The endpoint computes and stores core analytics such as qubit count, depth, and gate counts, and it deduplicates by circuit hash within the authenticated user and experiment scope.

The returned object is a ContextCircuitModel, which represents a persisted Haiqu circuit entity for MCP and API workflows rather than a raw Qiskit QuantumCircuit instance. This Haiqu model carries stable IDs, experiment ownership, stored analytics, and MCP context so later tools can reference the circuit directly without serializing or passing around the in-memory Qiskit circuit object itself.

When to Use:

Call this when a workflow starts from inline QASM and needs a stable circuit_id for later MCP tools.
Call this before run_circuits_on_qpu_or_simulator or compress_circuit_with_state_compression when the circuit is not already stored.

Constraints:

experiment_id must refer to an accessible experiment owned by the authenticated caller.
Circuit deduplication is hash-based within the caller and experiment scope, so this route may return an existing circuit instead of creating a new row.

Notes:

The response is the full ContextCircuitModel object, not a lightweight acknowledgment wrapper.
For agent-facing output, surface id, name, and the key analytics fields instead of repeating the raw QASM payload.

Args: user: Authenticated user resolved from the API key. data: Circuit payload containing the parent experiment ID, QASM source, and optional MCP context text. db: Active database session.

Returns: The created or reused circuit object.

Raises: HTTPException: Raised with 400 when the QASM payload cannot be parsed, or 404 when the parent experiment is not available to the caller.

POST

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

Body

application/json

Define payload for creating an MCP circuit from QASM.

Attributes: experiment_id: Parent experiment identifier. circuit_qasm: Quantum circuit source in QASM format. name: circuit name. description: Optional circuit description. context: Agent-facing reason for creating the circuit.

experiment_id

string

required

circuit_qasm

string

required

Quantum circuit source in QASM 2.0 or 3.0 format.

name

string

required

context

string

required

description

string | null

Optional plain-text circuit description.

Response

Successful Response

Extend a stored circuit model with MCP context text.

Attributes: context: ai summary describing the circuit role in the workflow.

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