IonQ

docs.ionq.com

Developer Tools

Working to build the world's best quantum computers to solve the world's most complex problems

llms.txt

IonQ Quantum Cloud Documentation

Docs

Get Backends: Retrieve a list of all available backends.
Get a Characterization: This endpoint retrieves a characterization.
Get All Backend Characterizations: This endpoint retrieves an array of all available backend characterizations, with pagination.
Get the Most Recent Backend Characterization: This endpoint retrieves the most recent backend characterization data available.
API Core Concepts
v0.3 Error Codes
Introduction
Cancel a Job: Cancel the execution of a single job by ID.
Cancel many Jobs: Cancel the execution of many jobs at once by passing a list of jobs.
Create a Job: To submit a program to be simulated or executed on our quantum hardware, POST it to the jobs endpoint. For ionq.circuit.v0 multi-circuit payloads, each entry in input.circuits inherits the parent gateset unless the circuit provides its own override.
Delete a Job: Permanently delete a job from our service. This cannot be undone.
Delete many Jobs: Permanently remove many jobs from our platform. This cannot be undone.
Get a specific Job: Retrieve a specific job by UUID.
Get a Job's output: Retrieve a specific job's results by UUID.
Get Jobs: NOTE: If request filters are provided, this endpoint will limit responses to 1 or more specific jobs based on those filters. This endpoint retrieves all jobs this API key is authorized to view.
Migrating from old versions
Multicircuit Jobs: This guide covers everything from setting up a multicircuit job, submitting it to IonQ's backend, and retrieving the results.
Using native gates with the IonQ API: Learn how to use our hardware-native gateset to run a circuit with the IonQ API
Get an Organization’s Report: 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.
Writing Quantum Programs
Get a Characterization: Retrieve detailed performance data for a characterization.
Get a backend: Retrieve detailed information about a specific backend.
Get Backends: List all available backends including QPUs and simulators.
Get all backend characterizations: Retrieve historical characterizations for a backend.
API v0.4 Reference: The IonQ Quantum Cloud API lets you submit quantum circuits, manage jobs, and access quantum computing resources programmatically.
Cancel a job: Stop the execution of job in queue.
Cancel jobs: Cancel multiple jobs simultaneously.
Create job: Submit a quantum circuit to run on a backend.
Delete job: Permanently remove a job and its associated data.
Delete jobs: Permanently remove multiple jobs and their data.
Get job: Retrieve detailed information about a specific job.
Get job cost: Retrieve billing information for a specific job.
Get job estimate: Retrieve cost estimate for a job.
Get jobs: List all jobs in your project with optional filtering.
Get jobs probabilities aggregated: Retrieve aggregated probability results from jobs.
Migrating to API v0.4: See what's new in API v0.4 and how to migrate from v0.3.
Create session: Create a new session for quantum computing jobs.
End session: End a session by its id and cancel any incomplete jobs in queue
Get session: Retrieve detailed information about a specific session.
Get sessions: List and filter all sessions in your organization.
Get usage costs: Gets usage cost broken down by time and job, project, or user.
Get current key: Gets information about the current token.
Cloud usage
Connecting a SAML Identity Provider: Enhance security and simplify user management by authenticating with your SAML-based SSO provider
Direct API Submissions: Learn how to submit jobs directly to the IonQ API v0.4
IonQ API Key Management with dotenv Integration: Discover how to effortlessly manage IonQ API keys across various projects by leveraging dotenv's automatic loading feature, enhancing security and codebase cleanliness.
Error Mitigation - Debiasing: Getting started with IonQ's built-in error mitigation
Native Gates: Getting started with IonQ's hardware-native gateset
Hosted Hybrid Service: Run hybrid execution loops using functions managed by IonQ's Cloud.
Managing API keys: Learn how to create and manage your IonQ API keys for secure access through SDKs and APIs.
QAOA solve with Fire Opal: Solve a Max-Cut optimization problem on IonQ hardware using Q-CTRL's Fire Opal QAOA solver
QPU Submission Checklist: Things to do before submitting to IonQ's hardware systems.
Simulation with Noise Models: Getting started with hardware noise model simulation
IonQ Documentation: Welcome to IonQ's developer documentation! Get started, learn advanced techniques, and browse through our reference materials.
Amazon Braket: Learn how to connect to IonQ products and services through AWS Braket
Getting started with Cirq: Learn how to use the Cirq SDK to submit quantum circuits to IonQ's simulators and quantum computers.
Using native gates with Cirq: Learn how to use our hardware-native gateset to run a circuit with Cirq
CUDA-Q: Learn how to use NVIDIA's CUDA Quantum to submit quantum circuits to IonQ's simulators and quantum computers.
Quantum SDKs: SDKs allow access to IonQ resources directly from within your code environment
PennyLane: Learn how to use PennyLane to submit quantum circuits to IonQ's simulators and quantum computers.
Using native gates with PennyLane: Learn how to use our hardware-native gateset to run a circuit with PennyLane
Getting started with qBraid: Learn how to use the qBraid-SDK to submit quantum circuits to IonQ's simulators and quantum computers.
Using native gates with qBraid: Learn how to use our hardware-native gateset to run a circuit with qBraid
Using debiasing with Qiskit: Learn how to use IonQ's error mitigation techniques with Qiskit
Getting started with Qiskit: Learn how to use the Qiskit SDK to submit quantum circuits to IonQ's simulators and quantum computers.
Compilation and native gates with Qiskit: Learn how to use our supported QIS gateset or hardware-native gateset to run a circuit with Qiskit
TensorFlow Quantum: Learn how to use TensorFlow Quantum to connect your ML workflows to IonQ's simulators and quantum computers.
Your Account: Learn how to manage your IonQ account, including API keys, security settings, and access controls.
Backends: Trapped-ion QPU hardware and QPU software simulators
Glossary: An glossary of IonQ Platform terminology
Introduction: Welcome to the IonQ Quantum Cloud
Jobs: Jobs are tasks running on IonQ systems, usually containing a circuit to run on a QPU.
Organizations
Platform Systems: An overview of some of the systems that make up the IonQ Quantum Cloud Platform
Projects: Projects are collaborative workspaces created in an organization to manage teams and resources.