Quantum API Godot Addon
The Godot addon is a runtime client you add to a Godot project. It provides health checks, text transforms, gate runs, backend discovery, transpile, and IBM circuit-job calls without becoming editor tooling.
Runtime / package
Godot 4 runtime addon
Version
Godot 4.x
What this addon is
The Godot addon is a reusable runtime client, not editor tooling. Add it to a game when you need health checks, text transforms, gate calls, backend discovery, transpile, or IBM circuit jobs from Godot code.
Install
-
Copy the addon into your project as addons/quantum_api_client/.
-
Preload res://addons/quantum_api_client/quantum_api_client.gd from your game script.
-
Create the client as a child node at runtime, then call apply_project_settings().
Configure project settings
The base URL is the web address the addon sends requests to. It accepts the mounted Quantum API address with or without /v1and normalizes the final request address.
[quantum_api]
base_url="https://davidjgrimsley.com/public-facing/api/quantum/v1"
backend_proxy_mode=true
direct_api_key=""
default_ibm_profile=""
First call: Health Check
const QuantumApiClientScript = preload("res://addons/quantum_api_client/quantum_api_client.gd")
var quantum_api_client: QuantumApiClient
func _ready() -> void:
quantum_api_client = QuantumApiClientScript.new()
add_child(quantum_api_client)
quantum_api_client.apply_project_settings()
quantum_api_client.health_check(func(success: bool, payload: Dictionary) -> void:
print(success, payload)
)
Run Gate example
quantum_api_client.run_gate({
"gate_type": "rotation",
"rotation_angle_rad": PI / 2.0,
}, func(success: bool, payload: Dictionary) -> void:
print(success, payload)
)
Backend proxy vs direct API key
Backend proxy mode
Keep this true for a shipped game. Your backend keeps the upstream API key out of the client.
Direct API key
Useful for local development, prototypes, and demos. Set it only after choosing to accept that the client can expose it.
Default IBM profile
An optional saved profile name used by IBM runtime calls when one is not supplied for that call.
IBM hardware jobs
Profile management stays on the Quantum API account site or your backend. The addon consumes an existing profile name. Pass it for IBM calls or setdefault_ibm_profile in project settings.
IBM hardware jobs have to wait in a queue before starting; get started at quantum.cloud.ibm.com.
quantum_api_client.list_backends(func(success: bool, payload: Dictionary) -> void:
print(success, payload)
, "ibm")
Available calls
-
health_check
-
transform_text
-
run_gate
-
list_backends
-
transpile
-
submit_circuit_job
Troubleshooting
-
Start with health_check to distinguish a connection problem from a request-shape problem.
-
When using direct mode, create an API key through the Quantum API account page and keep it out of a distributed build.
-
For IBM calls, verify the selected profile and backend availability before submitting a job.
Feedback, contributions, comments, and questions
Questions, corrections, and issue reports are welcome. Email DavidJGrimsley@gmail.com or open an issue at github.com/davidjgrimsley/quantum-api/issues.
Agent version (.md)
Coding agents can use the plain Markdown companion for this guide at /public-facing/api/quantum/godot-addon.md. For best results, also point the agent at /llms.txt so it can discover the core API guide, OpenAPI references, and the other integration guides.