API Reference

Client

class qdsv_bridge.QDSVBridgeClient(api_url=None, api_key=None, *, timeout=30.0, license_key=None, sdk_name='qdsv-bridge')

Bases: object

Client for QDSV Bridge public API endpoints.

Parameters:

  • api_url (str | None)

  • api_key (str | None)

  • timeout (float)

  • license_key (str | None)

  • sdk_name (str)

build(spec)

Return a canonical circuit plus editable QASM/Qiskit/IR artifacts.

Parameters:

spec (Mapping[str, Any])

Return type:

dict[str, Any]

capabilities()

Return operation-level compiler capabilities and service limits.

Return type:

dict[str, Any]

compile(spec, *, mode=None)
Parameters:

  • spec (Mapping[str, Any])

  • mode (str | None)

Return type:

dict[str, Any]

evaluate(spec)

Expert-evaluator mode: suggested QDSV materialization and variants.

Parameters:

spec (Mapping[str, Any])

Return type:

dict[str, Any]

explain(spec, *, mode=None)
Parameters:

  • spec (Mapping[str, Any])

  • mode (str | None)

Return type:

dict[str, Any]

export(spec, *, mode=None)
Parameters:

  • spec (Mapping[str, Any])

  • mode (str | None)

Return type:

dict[str, Any]

families()

Compatibility alias for the capability catalog endpoint.

Return type:

dict[str, Any]

generate(spec)

Generate a circuit only through canonical QDSV ProblemSpec/IR materialization.

Parameters:

spec (Mapping[str, Any])

Return type:

dict[str, Any]

classmethod local(*, api_url='http://localhost:18080/api', api_key=None, timeout=30.0, license_key=None)
Parameters:

  • api_url (str)

  • api_key (str | None)

  • timeout (float)

  • license_key (str | None)

Return type:

QDSVBridgeClient

prepare(spec)

Expert-constructor mode: semantic inputs for designing a custom circuit.

Parameters:

spec (Mapping[str, Any])

Return type:

dict[str, Any]

report(spec, *, mode=None, format='markdown')

Generate a shareable Bridge Report in markdown, html or json format.

Parameters:

  • spec (Mapping[str, Any])

  • mode (str | None)

  • format (str)

Return type:

dict[str, Any]

validate(spec, *, mode=None)
Parameters:

  • spec (Mapping[str, Any])

  • mode (str | None)

Return type:

dict[str, Any]

Exceptions

class qdsv_bridge.QDSVBridgeError

Base exception for the QDSV Bridge SDK.

class qdsv_bridge.QDSVBridgeAPIError

Raised when a transport error prevents calling the API.

class qdsv_bridge.QDSVBridgeHTTPError(status_code, payload)

Raised when the API returns an HTTP error response.

Parameters:

  • status_code (int)

  • payload (Any)