LogoLogo
  • Welcome to Quantum Cloud Services
  • Getting Started
    • Set up your environment
      • JupyterLab IDE
      • Install Locally
        • Quil SDK Docker Image
    • Quil SDK Overview
    • Running your first Quantum Program
  • Guides
    • Quil
      • What is Quil?
      • Language Support
      • Dynamic Control Flow
      • Customizing Program Readout
    • QPU vs. Simulator (QVM)
    • How to Use Rigetti QPUs
    • Access a QPU
      • QPU Reservations
      • On-Demand Access
      • QCS QPU Gateway
    • QCS Group Accounts
    • Interactive Tutorials
    • How Programs Are Built & Run
      • Execution and Request timeouts
    • The Lifecycle of a Program
    • The Rigetti QCS API
    • Using the QCS CLI
      • Using the Legacy QCS CLI
    • QCS Credentials
    • Benchmarking and Fidelity
  • Troubleshooting
    • Gathering Diagnostics
    • Report an Issue
  • Glossary
  • FAQ
  • References
    • pyQuil Reference
    • QCS API Specification
    • QCS CLI Reference
    • QCS Client Configuration
    • Quil / Quil-T Specification
    • quilc Reference
    • quil-rs Reference
    • QVM Reference
    • Rigetti Module for Cirq
    • Rigetti Provider for Qiskit
Powered by GitBook
On this page
  • Where is the API hosted?
  • Which packages should I use to interact with the API?

Was this helpful?

  1. Guides

The Rigetti QCS API

PreviousThe Lifecycle of a ProgramNextUsing the QCS CLI

Last updated 1 year ago

Was this helpful?

Rigetti QCS offers a stable, performant web API for access to QPUs and associated data. This API is served in two parts:

  • An OpenAPI-specified JSON HTTP API for management of accounts, reservations, and QPU data to include architecture and calibrations.

  • a gRPC-based API for interaction with the QPUs, to include translation. This is for the benefit of performance, streaming capabilities, and the efficient transfer of large binary data.

Where is the API hosted?

API
Root URL
Documentation

gRPC

OpenAPI

Which packages should I use to interact with the API?

Rigetti offers tools in several languages. See for more information. As a rule of thumb:

  • If you're working in Python and...

    • ...you're looking to run experiments, use forest-benchmarking if it contains utilities you find useful, and otherwise pyQuil

    • ...you're looking to run programs with a simple utility, use qcs

    • ...you're looking to interact with our API directly, use the qcs-api-client

  • If you're working in Rust, or want to create bindings for a different language (e.g. Julia), and...

    • ...you're looking to use the QPU to run programs, use qcs

    • ...you're looking to interact with the API directly, use the qcs-api-client-*suite of packages

our open-source landing page
https://grpc.qcs.rigetti.com
Rust package documentation
https://api.qcs.rigetti.com
Hosted documentation