{"openapi":"3.1.0","info":{"title":"AQT Public API","description":"\n## AQT Quantum Gates\n\nThe following quantum gates are natively supported by AQT backends and are defined in terms of the Pauli matrices\n$\n \\sigma_x =\n \\begin{pmatrix}\n 0 & 1 \\\\ 1 & 0\n \\end{pmatrix}\n$, $\n \\sigma_y =\n \\begin{pmatrix}\n 0 & -\\mathrm{i} \\\\ \\mathrm{i} & 0\n \\end{pmatrix}\n$ and $\\sigma_z =\n \\begin{pmatrix}\n 1 & 0 \\\\ 0 & -1\n \\end{pmatrix}.\n$\n\n\n\n\nR-gate:\n\nA single-qubit rotation around an arbitrary axis on the Bloch sphere's equatorial plane `GateR`\n\n
\n\nThe R-gate on qubit j with rotation angles θ and φ, both in units of π, is defined as\n $$\n U_{\\mathrm{R}}^j(\\theta,\\varphi) =\n \\exp\\left( -\\mathrm{i} \\theta \\frac{\\pi}{2}\n \\left[\\sin(\\varphi \\pi)\\sigma_y^j + \\cos(\\varphi \\pi)\\sigma_x^j \\right] \\right) =\n \\begin{pmatrix}\n \\cos(\\theta \\frac{\\pi}{2}) && -\\mathrm{i} e^{-\\mathrm{i} \\varphi \\pi}\\sin(\\theta \\frac{\\pi}{2})\\\\\n -\\mathrm{i} e^{\\mathrm{i} \\varphi \\pi}\\sin(\\theta \\frac{\\pi}{2}) && \\cos(\\theta \\frac{\\pi}{2})\n \\end{pmatrix}\n $$\nwith the Pauli matrices\n $$\n \\sigma_x =\n \\begin{pmatrix}\n 0 & 1 \\\\ 1 & 0\n \\end{pmatrix} ,\n \\sigma_y =\n \\begin{pmatrix}\n 0 & -\\mathrm{i} \\\\ \\mathrm{i} & 0\n \\end{pmatrix}.\n $$\n\nθ is the rotation angle in azimuthal direction around the chosen rotation axis and φ is the polar angle\ndefining the direction of the rotation axis in the equatorial plane of the Bloch sphere.\n\n**Examples:**\n $$\n \\begin{align*}\n U_{\\mathrm{R}}^j(0.5, 0) \\ket{0_j} &=\n \\frac{1}{\\sqrt{2}}\\left (\\ket{0_j} - \\mathrm{i}\\ket{1_j} \\right )\\\\\n U_{\\mathrm{R}}^j(0.5, 0.5) \\ket{0_j} &=\n \\frac{1}{\\sqrt{2}}\\left (\\ket{0_j} + \\ket{1_j} \\right )\n \\end{align*}\n $$\n\n**Warning:**\n\nSmall $\\theta$ values cannot be implemented natively by the AQT backends.\nSuch instances are thus rewritten as:\n\n$$\nR(\\theta,\\,\\phi)\\to R(\\pi,\\,\\phi+\\pi)\\cdot R(\\theta+\\pi,\\,\\phi)\n$$\n\nThe condition triggering this transformation is an implementation detail,\ntypically $\\theta \\leq \\pi/5$.\n \n\n\n\n\nRz-gate:\n\nA single-qubit rotation around the Bloch sphere's z-axis `GateRZ`\n\n
\n\nThe Rz-gate on qubit j with rotation angle φ in units of π is defined as\n $$\n U_{\\mathrm{R_z}}^j(\\varphi) =\n \\exp\\left( -\\mathrm{i} \\varphi \\frac{\\pi}{2} \\sigma_z^j \\right) =\n \\begin{pmatrix}\n \\cos(\\varphi \\frac{\\pi}{2}) -\\mathrm{i}\\sin(\\varphi \\frac{\\pi}{2}) && 0 \\\\\n 0 && \\cos(\\varphi \\frac{\\pi}{2}) +\\mathrm{i}\\sin(\\varphi \\frac{\\pi}{2})\n \\end{pmatrix}\n $$\nwith the Pauli matrix\n $$\n \\sigma_z =\n \\begin{pmatrix}\n 1 & 0 \\\\ 0 & -1\n \\end{pmatrix}.\n $$\n\nφ is the rotation angle in polar direction. The rotation axis is the z-axis of the Bloch sphere.\n\n**Examples:**\n $$\n \\begin{align*}\n U_{\\mathrm{R_z}}^j(1)\\frac{1}{\\sqrt{2}}\\left( \\ket{0_j} + \\ket{1_j}\\right) &=\n \\frac{1}{\\sqrt{2}}\\left (\\ket{0_j} - \\ket{1_j} \\right ) \\\\\n U_{\\mathrm{R_z}}^j(0.5)\\frac{1}{\\sqrt{2}}\\left (\\ket{0_j} + \\ket{1_j} \\right) &=\n \\frac{1}{\\sqrt{2}}\\left (\\ket{0_j} +\\mathrm{i}\\ket{1_j} \\right )\n \\end{align*}\n $$\n \n\n\n\n\nMS-gate:\n\nA two-qubit entangling gate of Mølmer-Sørensen-type `GateRXX`\n\n
\n\nThe MS-gate on qubits j and k with rotation angle θ in units of π is defined as\n $$\n \\begin{aligned}\n U_{\\mathrm{MS}}^{j,k} \\left (\\theta \\right) & =\n e^{\\mathrm{i}\\theta\\frac{\\pi}{2}}\\exp{\\left(-\\mathrm{i} \\theta \\pi {S_x}^2 \\right) }\n = \\begin{pmatrix}\n \\cos(\\theta \\frac{\\pi}{2}) & 0 & 0 && -\\mathrm{i}\\sin(\\theta \\frac{\\pi}{2}) \\\\\n 0 & \\cos(\\theta \\frac{\\pi}{2}) & -\\mathrm{i}\\sin(\\theta \\frac{\\pi}{2}) && 0 \\\\\n 0 & -\\mathrm{i}\\sin(\\theta\\frac{\\pi}{2}) & \\cos(\\theta \\frac{\\pi}{2}) && 0 \\\\\n -\\mathrm{i}\\sin(\\theta \\frac{\\pi}{2}) & 0 & 0 && \\cos(\\theta \\frac{\\pi}{2})\n \\end{pmatrix}\n \\end{aligned}\n $$\nwith\n $$\n S_x =\\frac{1}{2}\\left (\\sigma_x^j + \\sigma_x^k \\right)\n $$\nand the Pauli matrix\n $$\n \\sigma_x =\n \\begin{pmatrix}\n 0 & 1 \\\\ 1 & 0\n \\end{pmatrix}.\n $$\n\nA fully-entangling gate between qubit 0 and qubit 1 therefore is\n $$\n U_{\\mathrm{MS}}^{0,1} \\left (0.5 \\right) = \\frac{1}{\\sqrt{2}}\n \\begin{pmatrix}\n 1 && 0 && 0 && -\\mathrm{i} \\\\ 0 && 1 && -\\mathrm{i} && 0 \\\\\n 0 && -\\mathrm{i} && 1 && 0 \\\\ -\\mathrm{i} && 0 && 0 && 1\n \\end{pmatrix}\n $$\n\n**Examples:**\n $$\n \\begin{align*}\n U_{\\mathrm{MS}}^{j,k}(0.5) \\ket{0_j0_k} &=\n \\frac{1}{\\sqrt{2}}\\left (\\ket{0_j0_k} -\\mathrm{i} \\ket{1_j1_k} \\right ) \\\\\n U_{\\mathrm{MS}}^{j,k}(0.5) \\ket{1_j1_k} &=\n \\frac{1}{\\sqrt{2}}\\left ( -\\mathrm{i}\\ket{0_j0_k} + \\ket{1_j1_k} \\right )\n \\end{align*}\n $$\n \n\n## AQT Resources\n\n\n\nResource characterisation: \nData describing a resources properties `Characterisation`\n
\n\nResources are characterised by the following set of attributes that describe their\nperformance and capabilities:\n\n\n\nSingle-qubit gate fidelity \nfor each qubit `single_qubit_gate_fidelity`\n
\n\nA set of key-value pairs, where the key represents the index of the\nqubit and the value the fidelity for single-qubit gates.\n\nThe single-qubit gate fidelities are determined following the Randomized\nBenchmarking (RB) protocol. To measure the mean error rate we apply a\nsequence of randomly chosen gates followed by an inverting gate. The decay\nin performance as a function of the sequence length reveals the mean error\nrate per gate.\n\nEach gate fidelity is represented by a value between 0 and 100 and an additional\nuncertainty value. The sum of these two values cannot exceed 100.\n \n\n\n\n\nMean two qubit gate fidelity \n`mean_two_qubit_gate_fidelity`\n
\n\nThe mean two-qubit gate fidelity is determined following the Randomized\nBenchmarking (RB) protocol. To measure the mean error rate we apply a\nsequence of randomly chosen gates followed by an inverting gate. The decay\nin performance as a function of the sequence length reveals the mean error\nrate per gate.\n\nThe mean fidelity is represented by a value between 0 and 100 and an additional\nuncertainty value. The sum of these two values cannot exceed 100.\n \n\n\n\n\nSPAM fidelity \n(lower bound) `spam_fidelity_lower_bound`\n
\n\nThe SPAM fidelity or State Preparation and Measurement errors as the name\nindicates describe the errors that occur when the initial quantum state is\nnot prepared as intended or when the readout of the quantum state yields an\nincorrect result. To measure the state preparation errors the qubits are\nprepared in a known state followed by a set of repeated measurements that\nallow to estimate the probability of correctly preparing and measuring that\ngiven state. To estimate the measurement errors, a known gate is applied\nfollowed by a set of repeated measurements that allow to determine the error\nin preparing and measuring incorrectly the final state after that given\noperation.\n \n\n\n\n\nT2 coherence time in seconds \n(no Spin Echo) `t2_coherence_time_s`\n
\n\nThe T2 coherence time is estimated by performing Ramsey experiments with a\nvariable waiting time. The amplitude of the contrast of phase scans of Ramsey\nexperiments is measured as a function of the waiting time. The coherence is\nextracted by measuring the exponential decay of the contrast as a function\nof the waiting time.\n\nT2 is represented by a value between 0 and 100 and an additional\nuncertainty value. The sum of these two values cannot exceed 100.\n \n\n\n\n\nT1 in seconds \n`t1_s`\n
\n\nLiterature value from https://doi.org/10.1103/PhysRevA.62.032503.\n\nT1 is represented by a value between 0 and 100 and an additional\nuncertainty value. The sum of these two values cannot exceed 100.\n \n\n\n\n\nReadout time in microseconds \n`readout_time_micros`\n
\n\nThe readout time is the duration of the pulse used to detect the ion state.\n \n\n\n\n\nSingle-qubit gate duration \n`single_qubit_gate_duration_micros`\n
\n\nThe average duration to execute a single-qubit gate in microseconds.\n \n\n\n\n\nTwo-qubit gate duration \n`two_qubit_gate_duration_micros`\n
\n\nThe average duration to execute a two-qubit gate in microseconds.\n \n\n\n\n\nLast updated at \n`updated_at`\n
\n\nThe timestamp of the last characterisation data update.\n \n\n \n\n","version":"1.2.0"},"servers":[{"url":"/api/v1"}],"paths":{"/result/{job_id}":{"get":{"summary":"Request Result","description":"Request job results.\n\nNB once a job has finished processing and the result is queried, it will only remain available for a period of 24 hours. After this period, the result will be permanently deleted from the system and the job will no longer be retrievable. Further requests after expiration will be responded to with a 410 GONE status code.","operationId":"request_result_result__job_id__get","security":[{"Bearer Token":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"include_timing_data","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Timing Data"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultResponse"},"examples":{"Queued Job":{"summary":"Queued Job","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"queued"}}},"Ongoing Job":{"summary":"Ongoing Job","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"ongoing","finished_count":0}}},"Failed Job":{"summary":"Failed Job","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"error","message":"detailed error message"}}},"Cancelled Job":{"summary":"Cancelled Job","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"cancelled"}}},"Finished Job":{"summary":"Finished Job","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"finished","result":{"0":[[1,0],[1,1],[0,0],[1,1],[1,1]]}}}},"Queued Job with timing data":{"summary":"Queued Job with timing data","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"queued","timing_data":[{"new_status":"queued","timestamp":"2025-02-27T13:37:00"}]}}},"Ongoing Job with timing data":{"summary":"Ongoing Job with timing data","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"ongoing","timing_data":[{"new_status":"queued","timestamp":"2025-02-27T13:37:00"},{"new_status":"ongoing","timestamp":"2025-02-27T13:37:10"}],"finished_count":0}}},"Failed Job with timing data":{"summary":"Failed Job with timing data","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"error","timing_data":[{"new_status":"queued","timestamp":"2025-02-27T13:37:00"},{"new_status":"ongoing","timestamp":"2025-02-27T13:37:10"},{"new_status":"error","timestamp":"2025-02-27T13:37:40"}],"message":"detailed error message"}}},"Cancelled Job with timing data":{"summary":"Cancelled Job with timing data","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"cancelled","timing_data":[{"new_status":"queued","timestamp":"2025-02-27T13:37:00"},{"new_status":"cancelled","timestamp":"2025-02-27T13:37:10"}]}}},"Finished Job with timing data":{"summary":"Finished Job with timing data","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"finished","timing_data":[{"new_status":"queued","timestamp":"2025-02-27T13:37:00"},{"new_status":"ongoing","timestamp":"2025-02-27T13:37:10"},{"new_status":"finished","timestamp":"2025-02-27T13:37:40"}],"result":{"0":[[1,0],[1,1],[0,0],[1,1],[1,1]]}}}}}}}},"401":{"description":"Unauthorized"},"404":{"description":"Job not found"},"410":{"description":"The job has already been retrieved"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/workspaces":{"get":{"summary":"Workspaces","description":"List of available workspaces and devices","operationId":"workspaces_workspaces_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Workspace"},"title":"Response Workspaces Workspaces Get"},"examples":[{"summary":"","value":[{"id":"default","accepting_job_submissions":true,"jobs_being_processed":true,"resources":[{"id":"simulator","name":"Simulator without noise","type":"simulator"},{"id":"simulator_noise","name":"Simulator with noise","type":"device"}]}]}]}}},"401":{"description":"Unauthorized"}},"security":[{"Bearer Token":[]}]}},"/submit/{workspace}/{resource}":{"post":{"summary":"Submit Job","description":"Submit a quantum circuit.","operationId":"submit_job_submit__workspace___resource__post","security":[{"Bearer Token":[]}],"parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","title":"Workspace"}},{"name":"resource","in":"path","required":true,"schema":{"type":"string","title":"Resource"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitJobRequest"},"examples":{"Default":{"summary":"Default example","value":{"job_type":"quantum_circuit","label":"Example computation","payload":{"circuits":[{"repetitions":5,"quantum_circuit":[{"qubit":0,"phi":0.5,"operation":"RZ"},{"qubit":1,"phi":0.25,"theta":0.5,"operation":"R"},{"qubits":[0,1],"theta":0.5,"operation":"RXX"},{"operation":"MEASURE"}],"number_of_qubits":2}]}}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitJobResponse"},"examples":[{"summary":"Default example","value":{"job":{"job_id":"ccaa39de-d0f3-4c8b-bdb1-4d74f0c2f450","job_type":"quantum_circuit","label":"Example computation","resource_id":"simulator","workspace_id":"default"},"response":{"status":"queued"}}}]}}},"401":{"description":"Unauthorized"},"403":{"description":"Workspace not available."},"404":{"description":"Resource not available in workspace."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/{job_id}":{"delete":{"tags":["jobs"],"summary":"Cancel Job Handler","description":"Cancels a submitted job.\n\nJobs that have not yet been started will no longer be submitted\nfor processing. Jobs that have already begun will stop at the end of the current circuit.\n\nAny results already processed will not be deleted.","operationId":"cancel_job_handler_jobs__job_id__delete","security":[{"Bearer Token":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"Unauthorized"},"208":{"description":"The job has already been cancelled"},"403":{"description":"User does not have required permissions to cancel this job"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/resources/{resource_id}":{"get":{"tags":["resources"],"summary":"Get Resource","description":"Provides details for the resource identified by 'resource_id'","operationId":"get_resource_resources__resource_id__get","security":[{"Bearer Token":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"responses":{"200":{"description":"Information about the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceDetails"},"examples":[{"summary":"Resource","value":{"id":"simulator_noise","name":"Noisy Simulator","type":"simulator","status":"online","available_qubits":5,"status_updated_at":"2025-04-08T13:12:30.321000"}},{"summary":"Resource with characterisation data","value":{"id":"ibex","name":"Ibex","type":"simulator","status":"online","available_qubits":5,"status_updated_at":"2025-04-08T13:12:30.321000","characterisation":{"single_qubit_gate_fidelity":{"0":{"value":99.9998,"uncertainty":2e-05},"1":{"value":99.99972,"uncertainty":3e-05},"2":{"value":99.99941,"uncertainty":7e-05},"3":{"value":99.99969,"uncertainty":4e-05},"4":{"value":99.99973,"uncertainty":3e-05},"5":{"value":99.9998,"uncertainty":2e-05},"6":{"value":99.99952,"uncertainty":4e-05},"7":{"value":99.99956,"uncertainty":7e-05},"8":{"value":99.99962,"uncertainty":3e-05},"9":{"value":99.99979,"uncertainty":2e-05},"10":{"value":99.99932,"uncertainty":8e-05},"11":{"value":99.99978,"uncertainty":2e-05}},"mean_two_qubit_gate_fidelity":{"value":98.9,"uncertainty":0.0019},"spam_fidelity_lower_bound":99.74,"t2_coherence_time_s":{"value":173.8,"uncertainty":31.3},"t1_s":{"value":1.168,"uncertainty":0.007},"readout_time_micros":1500.0,"single_qubit_gate_duration_micros":22.0,"two_qubit_gate_duration_micros":315.0,"updated_at":"2025-02-22T12:29:03"}}}]}}},"401":{"description":"Unauthorized"},"403":{"description":"Resource not available."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/resources/{resource_id}/characterisation":{"get":{"tags":["resources"],"summary":"Get Resource Characterisation","description":"Provides characterisation details for the resource identified by 'resource_id'","operationId":"get_resource_characterisation_resources__resource_id__characterisation_get","security":[{"Bearer Token":[]}],"parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"responses":{"200":{"description":"Characterisation information about the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CharacterisationResponse"},"examples":[{"summary":"Example characterisation response","value":{"single_qubit_gate_fidelity":{"0":{"value":99.9998,"uncertainty":2e-05},"1":{"value":99.99972,"uncertainty":3e-05},"2":{"value":99.99941,"uncertainty":7e-05},"3":{"value":99.99969,"uncertainty":4e-05},"4":{"value":99.99973,"uncertainty":3e-05},"5":{"value":99.9998,"uncertainty":2e-05},"6":{"value":99.99952,"uncertainty":4e-05},"7":{"value":99.99956,"uncertainty":7e-05},"8":{"value":99.99962,"uncertainty":3e-05},"9":{"value":99.99979,"uncertainty":2e-05},"10":{"value":99.99932,"uncertainty":8e-05},"11":{"value":99.99978,"uncertainty":2e-05}},"mean_two_qubit_gate_fidelity":{"value":98.9,"uncertainty":0.0019},"spam_fidelity_lower_bound":99.74,"t2_coherence_time_s":{"value":173.8,"uncertainty":31.3},"t1_s":{"value":1.168,"uncertainty":0.007},"readout_time_micros":1500.0,"single_qubit_gate_duration_micros":22.0,"two_qubit_gate_duration_micros":315.0,"updated_at":"2025-02-22T12:29:03","two_qubit_gate_fidelity":[{"value":99.9998,"uncertainty":2e-05,"qubits":[0,1]},{"value":99.99972,"uncertainty":3e-05,"qubits":[1,7]}]}}]}}},"401":{"description":"Unauthorized"},"204":{"description":"No characterisation available."},"403":{"description":"Resource not available."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BasicJobMetadata":{"properties":{"job_id":{"type":"string","format":"uuid","title":"Job Id","description":"Id that uniquely identifies the job. This is used to request results."},"job_type":{"type":"string","const":"quantum_circuit","title":"Job Type","default":"quantum_circuit"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"resource_id":{"type":"string","title":"Resource Id"},"workspace_id":{"type":"string","title":"Workspace Id"}},"type":"object","required":["job_id","resource_id","workspace_id"],"title":"BasicJobMetadata","description":"Metadata for a user-submitted job."},"Characterisation":{"properties":{"single_qubit_gate_fidelity":{"additionalProperties":{"$ref":"#/components/schemas/GateFidelity"},"type":"object","title":"Single Qubit Gate Fidelity"},"mean_two_qubit_gate_fidelity":{"$ref":"#/components/schemas/GateFidelity"},"spam_fidelity_lower_bound":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Spam Fidelity Lower Bound"},"t2_coherence_time_s":{"$ref":"#/components/schemas/PositiveFloatValueWithUncertainty"},"t1_s":{"$ref":"#/components/schemas/PositiveFloatValueWithUncertainty"},"readout_time_micros":{"type":"number","minimum":0.0,"title":"Readout Time Micros"},"single_qubit_gate_duration_micros":{"type":"number","minimum":0.0,"title":"Single Qubit Gate Duration Micros"},"two_qubit_gate_duration_micros":{"type":"number","minimum":0.0,"title":"Two Qubit Gate Duration Micros"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["single_qubit_gate_fidelity","mean_two_qubit_gate_fidelity","spam_fidelity_lower_bound","t2_coherence_time_s","t1_s","readout_time_micros","single_qubit_gate_duration_micros","two_qubit_gate_duration_micros","updated_at"],"title":"Characterisation","description":"Characterisation data describing a resources properties.\n\nDetails can be found in the description of `Characterisation` in https://arnica.aqt.eu/api/v1/docs\n\nAttributes:\n single_qubit_gate_fidelity: The single-qubit gate fidelity for each qubit.\n mean_two_qubit_gate_fidelity: The mean two-qubit gate fidelity.\n spam_fidelity_lower_bound: The SPAM fidelity (lower bound).\n t2_coherence_time_s: T2 coherence time (no Spin Echo) in seconds.\n t1_s: T1 in seconds. Literature value from https://doi.org/10.1103/PhysRevA.62.032503.\n readout_time_micros: The duration of detecting the ion state in microseconds.\n single_qubit_gate_duration_micros: Average duration to execute a single-qubit gate in microseconds.\n two_qubit_gate_duration_micros: Average duration to execute a two-qubit gate in microseconds.\n updated_at: Timestamp when this was last updated."},"CharacterisationResponse":{"properties":{"single_qubit_gate_fidelity":{"additionalProperties":{"$ref":"#/components/schemas/GateFidelity"},"type":"object","title":"Single Qubit Gate Fidelity"},"mean_two_qubit_gate_fidelity":{"$ref":"#/components/schemas/GateFidelity"},"spam_fidelity_lower_bound":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Spam Fidelity Lower Bound"},"t2_coherence_time_s":{"$ref":"#/components/schemas/PositiveFloatValueWithUncertainty"},"t1_s":{"$ref":"#/components/schemas/PositiveFloatValueWithUncertainty"},"readout_time_micros":{"type":"number","minimum":0.0,"title":"Readout Time Micros"},"single_qubit_gate_duration_micros":{"type":"number","minimum":0.0,"title":"Single Qubit Gate Duration Micros"},"two_qubit_gate_duration_micros":{"type":"number","minimum":0.0,"title":"Two Qubit Gate Duration Micros"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"two_qubit_gate_fidelity":{"items":{"$ref":"#/components/schemas/TwoQubitGateFidelity"},"type":"array","title":"Two Qubit Gate Fidelity"}},"type":"object","required":["single_qubit_gate_fidelity","mean_two_qubit_gate_fidelity","spam_fidelity_lower_bound","t2_coherence_time_s","t1_s","readout_time_micros","single_qubit_gate_duration_micros","two_qubit_gate_duration_micros","updated_at"],"title":"CharacterisationResponse","description":"Model for the characterisation of a resource."},"Circuit":{"items":{"$ref":"#/components/schemas/OperationModel"},"type":"array","maxItems":2000,"minItems":1,"title":"Circuit","description":"Json encoding of a quantum circuit."},"GateFidelity":{"properties":{"value":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Value"},"uncertainty":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Uncertainty"}},"type":"object","required":["value","uncertainty"],"title":"GateFidelity","description":"**Gate fidelity**\n\nSpecifies the gate fidelity with a value between 0 and 100 and an additional\nuncertainty value. The sum of these two values cannot exceed 100."},"GateR":{"properties":{"qubit":{"type":"integer","minimum":0.0,"title":"Qubit"},"phi":{"type":"number","maximum":2.0,"minimum":0.0,"title":"Phi"},"theta":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Theta"},"operation":{"type":"string","const":"R","title":"Operation"}},"additionalProperties":false,"type":"object","required":["qubit","phi","theta","operation"],"title":"GateR","description":"### A single-qubit rotation around an arbitrary axis on the Bloch sphere's equatorial plane.\n\nDetails can be found in the description of `GateR` in https://arnica.aqt.eu/api/v1/docs"},"GateRXX":{"properties":{"qubits":{"items":{"type":"integer","minimum":0.0},"type":"array","maxItems":2,"minItems":2,"title":"Qubits"},"theta":{"type":"number","maximum":0.5,"minimum":0.0,"title":"Theta"},"operation":{"type":"string","const":"RXX","title":"Operation"}},"additionalProperties":false,"type":"object","required":["qubits","theta","operation"],"title":"GateRXX","description":"### A two-qubit entangling gate of Mølmer-Sørensen-type.\n\nDetails can be found in the description of `GateRXX` in https://arnica.aqt.eu/api/v1/docs"},"GateRZ":{"properties":{"qubit":{"type":"integer","minimum":0.0,"title":"Qubit"},"phi":{"type":"number","title":"Phi"},"operation":{"type":"string","const":"RZ","title":"Operation"}},"additionalProperties":false,"type":"object","required":["qubit","phi","operation"],"title":"GateRZ","description":"### A single-qubit rotation around the Bloch sphere's z-axis.\n\nDetails can be found in the description of `GateRZ` in https://arnica.aqt.eu/api/v1/docs"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"JobStatus":{"type":"string","enum":["cancelled","error","finished","ongoing","queued"],"title":"JobStatus","description":"Status of an ARNICA job.\n\nPossible values are:\n - CANCELLED: The job was cancelled\n - ERROR: The job processing failed\n - FINISHED: The job was processed successfully\n - ONGOING: The job is being processed\n - QUEUED: The job is in the queue and waiting to be processed"},"Measure":{"properties":{"operation":{"type":"string","const":"MEASURE","title":"Operation"}},"additionalProperties":false,"type":"object","required":["operation"],"title":"Measure","description":"Measurement operation.\n\nThe MEASURE operation instructs the resource\nto perform a projective measurement of all qubits."},"OperationModel":{"oneOf":[{"$ref":"#/components/schemas/GateRZ"},{"$ref":"#/components/schemas/GateR"},{"$ref":"#/components/schemas/GateRXX"},{"$ref":"#/components/schemas/Measure"}],"title":"OperationModel","description":"Model for the items in a Circuit.\n\nThis extra wrapper is introduced to leverage the pydantic\ntagged-union parser.","discriminator":{"propertyName":"operation","mapping":{"MEASURE":"#/components/schemas/Measure","R":"#/components/schemas/GateR","RXX":"#/components/schemas/GateRXX","RZ":"#/components/schemas/GateRZ"}}},"PositiveFloatValueWithUncertainty":{"properties":{"value":{"type":"number","exclusiveMinimum":0.0,"title":"Value"},"uncertainty":{"type":"number","minimum":0.0,"title":"Uncertainty"}},"type":"object","required":["value","uncertainty"],"title":"PositiveFloatValueWithUncertainty"},"QuantumCircuit":{"properties":{"repetitions":{"type":"integer","maximum":2000.0,"minimum":1.0,"title":"Repetitions"},"quantum_circuit":{"$ref":"#/components/schemas/Circuit"},"number_of_qubits":{"type":"integer","maximum":31.0,"minimum":1.0,"title":"Number Of Qubits"}},"type":"object","required":["repetitions","quantum_circuit","number_of_qubits"],"title":"QuantumCircuit","description":"A quantum circuit-type job that can run on a computing resource."},"QuantumCircuits":{"properties":{"circuits":{"items":{"$ref":"#/components/schemas/QuantumCircuit"},"type":"array","maxItems":50,"minItems":1,"title":"Circuits"}},"type":"object","required":["circuits"],"title":"QuantumCircuits","description":"Payload of a SubmitJobRequest with job_type 'quantum_circuit'."},"RRCancelled":{"properties":{"status":{"type":"string","const":"cancelled","title":"Status","default":"cancelled"},"timing_data":{"anyOf":[{"items":{"$ref":"#/components/schemas/StatusChange"},"type":"array"},{"type":"null"}],"title":"Timing Data"}},"type":"object","title":"RRCancelled","description":"Result metadata for a cancelled job."},"RRError":{"properties":{"status":{"type":"string","const":"error","title":"Status","default":"error"},"timing_data":{"anyOf":[{"items":{"$ref":"#/components/schemas/StatusChange"},"type":"array"},{"type":"null"}],"title":"Timing Data"},"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"RRError","description":"Result metadata for a failed job."},"RRFinished":{"properties":{"status":{"type":"string","const":"finished","title":"Status","default":"finished"},"timing_data":{"anyOf":[{"items":{"$ref":"#/components/schemas/StatusChange"},"type":"array"},{"type":"null"}],"title":"Timing Data"},"result":{"additionalProperties":{"items":{"items":{"type":"integer","maximum":1.0,"minimum":0.0},"type":"array"},"type":"array"},"type":"object","title":"Result"}},"type":"object","required":["result"],"title":"RRFinished","description":"Result metadata for a finished job."},"RROngoing":{"properties":{"status":{"type":"string","const":"ongoing","title":"Status","default":"ongoing"},"timing_data":{"anyOf":[{"items":{"$ref":"#/components/schemas/StatusChange"},"type":"array"},{"type":"null"}],"title":"Timing Data"},"finished_count":{"type":"integer","minimum":0.0,"title":"Finished Count"}},"type":"object","required":["finished_count"],"title":"RROngoing","description":"Result metadata for an ongoing job."},"RRQueued":{"properties":{"status":{"type":"string","const":"queued","title":"Status","default":"queued"},"timing_data":{"anyOf":[{"items":{"$ref":"#/components/schemas/StatusChange"},"type":"array"},{"type":"null"}],"title":"Timing Data"}},"type":"object","title":"RRQueued","description":"Result metadata for a queued job."},"ResourceDetails":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/ResourceType"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"available_qubits":{"type":"integer","title":"Available Qubits"},"status_updated_at":{"type":"string","format":"date-time","title":"Status Updated At"},"characterisation":{"anyOf":[{"$ref":"#/components/schemas/Characterisation"},{"type":"null"}]}},"type":"object","required":["id","name","type","status","available_qubits","status_updated_at"],"title":"ResourceDetails","description":"Model for the response of the ARNICA resource details endpoint."},"ResourceStatus":{"type":"string","enum":["maintenance","offline","online","unavailable"],"title":"ResourceStatus","description":"Status of an ARNICA quantum resource.\n\nThe possible values are:\n - MAINTENANCE: The resource is under maintenance\n - OFFLINE: The resource is offline\n - ONLINE: The resource is online\n - UNAVAILABLE: The status of the resource is currently not available to the user"},"ResourceType":{"type":"string","enum":["simulator","device"],"title":"ResourceType","description":"Type of an ARNICA quantum resource.\n\nThe possible values are:\n - SIMULATOR: Service that simulates the behaviour of a quantum computer\n - DEVICE: A physical quantum computer"},"ResultResponse":{"properties":{"job":{"$ref":"#/components/schemas/BasicJobMetadata"},"response":{"anyOf":[{"$ref":"#/components/schemas/RRQueued"},{"$ref":"#/components/schemas/RROngoing"},{"$ref":"#/components/schemas/RRFinished"},{"$ref":"#/components/schemas/RRError"},{"$ref":"#/components/schemas/RRCancelled"}],"title":"Response"}},"type":"object","required":["job","response"],"title":"ResultResponse","description":"Response body model for the request result endpoint."},"StatusChange":{"properties":{"new_status":{"$ref":"#/components/schemas/JobStatus"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"}},"type":"object","required":["new_status","timestamp"],"title":"StatusChange","description":"Model for a job status change."},"SubmitJobRequest":{"properties":{"job_type":{"type":"string","const":"quantum_circuit","title":"Job Type","default":"quantum_circuit"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"payload":{"$ref":"#/components/schemas/QuantumCircuits"}},"type":"object","required":["payload"],"title":"SubmitJobRequest","description":"Request body model for the submit job endpoint."},"SubmitJobResponse":{"properties":{"job":{"$ref":"#/components/schemas/BasicJobMetadata"},"response":{"$ref":"#/components/schemas/RRQueued","default":{"status":"queued"}}},"type":"object","required":["job"],"title":"SubmitJobResponse","description":"Response body model for the submit job endpoint."},"TwoQubitGateFidelity":{"properties":{"value":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Value"},"uncertainty":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Uncertainty"},"qubits":{"prefixItems":[{"type":"integer"},{"type":"integer"}],"type":"array","maxItems":2,"minItems":2,"title":"Qubits"}},"type":"object","required":["value","uncertainty","qubits"],"title":"TwoQubitGateFidelity","description":"Two-qubit gate fidelity for a specific pair of qubits.\n\nAttributes:\n qubits: The pair of qubits for which this fidelity applies. By convention, the lower-indexed\n qubit comes first.\n value: The fidelity value for this pair of qubits, between 0 and 100.\n uncertainty: The uncertainty associated with the fidelity value, between 0 and 100."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Workspace":{"properties":{"id":{"type":"string","title":"Id"},"accepting_job_submissions":{"type":"boolean","title":"Accepting Job Submissions"},"jobs_being_processed":{"type":"boolean","title":"Jobs Being Processed"},"resources":{"items":{"$ref":"#/components/schemas/WorkspaceResource"},"type":"array","title":"Resources"}},"type":"object","required":["id","accepting_job_submissions","jobs_being_processed","resources"],"title":"Workspace","description":"Model for an item in the workspace list response."},"WorkspaceResource":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/ResourceType"}},"type":"object","required":["id","name","type"],"title":"WorkspaceResource","description":"Model of a resource within a workspace."}},"securitySchemes":{"Bearer Token":{"type":"http","description":"To authenticate for the API provide a valid token (without 'Bearer')","scheme":"bearer"}}}}