Skip to main content
GET
/
characterizations
/
{UUID}
cURL
curl "https://api.ionq.co/v0.3/characterizations/aa54e783-0a9b-4f73-ad2f-63983b6aa4a8" \
  -H "Authorization: apiKey your-api-key"
import requests

url = "https://api.ionq.co/v0.3/characterizations/{UUID}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.ionq.co/v0.3/characterizations/{UUID}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionq.co/v0.3/characterizations/{UUID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.ionq.co/v0.3/characterizations/{UUID}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.ionq.co/v0.3/characterizations/{UUID}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ionq.co/v0.3/characterizations/{UUID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": 123,
  "qubits": 1,
  "connectivity": [
    [
      0,
      1
    ],
    [
      0,
      2
    ],
    "...",
    [
      10,
      9
    ]
  ],
  "fidelity": {
    "spam": {
      "mean": 1,
      "stderr": 1,
      "median": 1
    }
  },
  "timing": {
    "readout": 123,
    "reset": 123,
    "1q": 123,
    "2q": 123,
    "t1": 123,
    "t2": 123
  }
}

Authorizations

Authorization
string
header
required

API keys are associated with a user and can be created on the IonQ Quantum Cloud application. To authenticate, prefix your API Key with apiKey and place it in the Authorization request header. Ex: Authorization: apiKey your-api-key

Path Parameters

UUID
string<uuid>
required

A UUID identifying a specific resource

Response

200 - application/json

Successfully retrieved current characterization

Quantum hardware characterization data.

id
string<uuid>

UUID of the characterization.

date
integer

Time of the measurement, from Unix epoch in seconds.

backend
enum<string>

The calibrated QPU being characterized.

Available options:
qpu.harmony,
qpu.aria-1,
qpu.aria-2,
qpu.forte-1,
qpu.forte-enterprise-1
qubits
integer

The number of qubits available.

Required range: x >= 0
connectivity
integer[][]

An array of valid, unordered tuples of possible qubits for executing two-qubit gates (e.g., [[0, 1], [0, 2], [1, 2]])

Example:
[[0, 1], [0, 2], "...", [10, 9]]
fidelity
object

Fidelity for single-qubit (1q) and two-qubit (2q) gates, and State Preparation and Measurement (spam) operations. Currently provides only mean fidelity; additional statistical data will be added in the future.

timing
object

Time, in seconds, of various system properties: t1 time, t2 time, 1q gate time, 2q gate time, readout time, and qubit reset time.