Retrieve aggregated probability results from jobs.

IonQ Quantum Cloud Documentation

Welcome to IonQ's developer documentation! Get started, learn advanced techniques, and browse through our reference materials.

Introduction

IonQ Documentation

Learn how to create and manage your IonQ API keys for secure access through SDKs and APIs.

Managing API keys

Learn how to submit jobs directly to the IonQ API

Direct API Submissions

Things to do before submitting to IonQ's hardware systems.

QPU Submission Checklist

Getting started with hardware noise model simulation

Simulation with Noise Models

Getting started with IonQ's hardware-native gateset

Native Gates

Run hybrid execution loops using functions managed by IonQ's Cloud.

Hosted Hybrid Service

Learn how to manage your IonQ account, including API keys, security settings, and access controls.

Your Account

Trapped-ion QPU hardware and QPU software simulators

Backends

Jobs are tasks running on IonQ systems, usually containing a circuit to run on a QPU.

Jobs

Organizations

Projects are collaborative workspaces created in an organization to manage teams and resources.

Projects

An overview of some of the systems that make up the IonQ Quantum Cloud Platform

Platform Systems

Glossary

Learn how to connect to IonQ products and services through AWS Braket

Amazon Braket

Enhance security and simplify user management by authenticating with your SAML-based SSO provider

Connecting a SAML Identity Provider

SDKs allow access to IonQ resources directly from within your code environment

Overview

Quantum SDKs

Learn how to use NVIDIA's CUDA Quantum to submit quantum circuits to IonQ's simulators and quantum computers.

CUDA-Q

The IonQ Quantum Cloud API lets you submit quantum circuits, manage jobs, and access quantum computing resources programmatically. 

API v0.4 Reference

See what's new in API v0.4 and how to migrate from v0.3.

Migrating to API v0.4

Submit a quantum circuit to run on a backend.

Retrieve detailed information about a specific job.

List all jobs in your project with optional filtering.

Retrieve billing information for a specific job.

Cancel a job

Permanently remove a job and its associated data.

Permanently remove multiple jobs and their data.

Retrieve probability distribution results from a job.

List all available backends including QPUs and simulators.

Get Backends

Retrieve detailed information about a specific backend.

Get a Backend

Retrieve detailed performance data for a characterization.

Get a Characterization

Retrieve historical characterizations for a backend.

Get All Backend Characterizations

API Core Concepts

v0.3 Error Codes

Writing Quantum Programs

Migrating from old versions

This guide covers everything from setting up a multicircuit job, submitting it to IonQ's backend, and retrieving the results.

Multicircuit Jobs

Learn how to use our hardware-native gateset to run a circuit with the IonQ API

Using native gates with the IonQ API

**NOTE**: If request filters are provided, this endpoint will limit responses to 1 or more specific jobs based on those filters.<br /><br />
This endpoint retrieves all jobs this API key is authorized to view.


Get Jobs

To submit a program to be simulated or executed on our quantum hardware, `POST` it to the `jobs` endpoint.

Create a Job

Permanently remove many jobs from our platform. This cannot be undone.

Delete many Jobs

Get a specific Job

Permanently delete a job from our service. This cannot be undone.

Delete a Job

Retrieve a specific job's results by UUID.

Get a Job's output

Cancel the execution of a single job by ID.

Cancel a Job

Cancel the execution of many jobs at once by passing a list of jobs.

Cancel many Jobs

This endpoint retrieves an array of all available backend characterizations, with pagination.

This endpoint retrieves the most recent backend characterization data available.

Get the Most Recent Backend Characterization

This endpoint retrieves a characterization.

Retrieve a list of all available backends.

Get a usage report for the given organization from the start_date and end_date, detailing how much usage went to each QPU during that period. If no start_date or end_date are provided, period defaults to last 30 days until current time.

Get an Organization’s Report

Join our Slack

Example Notebooks

Other Resources

Home

SDKs

API v0.4 (Latest)

API v0.3

Sign In

Learn how to use the Qiskit SDK to submit quantum circuits to IonQ's simulators and quantum computers.

Getting started with Qiskit

Learn how to use IonQ's error mitigation techniques with Qiskit

Using debiasing with Qiskit

Learn how to use our hardware-native gateset to run a circuit with Qiskit

Using native gates with Qiskit

Learn how to use the Cirq SDK to submit quantum circuits to IonQ's simulators and quantum computers.

Getting started with Cirq

Learn how to use our hardware-native gateset to run a circuit with Cirq

Using native gates with Cirq

Learn how to use PennyLane to submit quantum circuits to IonQ's simulators and quantum computers.

PennyLane

Learn how to use our hardware-native gateset to run a circuit with PennyLane

Using native gates with PennyLane

Learn how to use the qBraid-SDK to submit quantum circuits to IonQ's simulators and quantum computers.

Getting started with qBraid

Learn how to use our hardware-native gateset to run a circuit with qBraid

IonQ v0.4 API

Jobs

Backends

Get jobs probabilities aggregated