This is the documentation for the Rigetti QCS HTTP API.
You can find out more about Rigetti at https://rigetti.com, and also interact with QCS via the web at https://qcs.rigetti.com.
This API is documented in OpenAPI format and so is compatible with the dozens of language-specific client generators available here and elsewhere on the web.
This API follows REST design principles where appropriate, and otherwise an HTTP RPC paradigm. We adhere to the Google API Improvement Proposals where reasonable to provide a consistent, intuitive developer experience. HTTP response codes match their specifications, and error messages fit a common format.
All access to the QCS API requires OAuth2 authentication provided by Okta. You can request access here. Once you have a user account, you can download your access token from QCS here.
That access token is valid for 24 hours after issuance. The value of access_token within the
JSON file is the token used for authentication (don't use the entire JSON file).
Authenticate requests using the Authorization header and a Bearer prefix:
curl --header \"Authorization: Bearer eyJraW...Iow\"
Requests can be redirected through client-side proxies based on the presence of HTTP_PROXY (for http connections) and HTTPS_PROXY (for https connections) environment variables.
Currently, the supported proxy schemes are http, https, and socks5.
Access to the quantum processors themselves is not yet provided directly by this HTTP API, but is instead performed over ZeroMQ/rpcq. Until that changes, we suggest using pyquil to build and execute quantum programs via the Legacy API.
Our legacy HTTP API remains accessible at https://forest-server.qcs.rigetti.com, and it shares a source of truth with this API's services. You can use either service with the same user account and means of authentication. We strongly recommend using the API documented here, as the legacy API is on the path to deprecation.
For more information, please visit https://rigetti.zendesk.com
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
org.openapitools.codegen.languages.RustClientCodegenPut the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./openapi" }
All URIs are relative to https://api.qcs.rigetti.com
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AccountApi | addgroupuser | POST /v1/groups:addUser | Add user to a group AccountApi | getgroupbalance | GET /v1/groups/{groupName}/balance | Get Group Balance AccountApi | getgroupbillingcustomer | GET /v1/groups/{groupName}/billingCustomer | *AccountApi* | getgroupupcomingbillinginvoice | GET /v1/groups/{groupName}/billingInvoices:getUpcoming | *AccountApi* | getuserbalance | GET /v1/users/{userId}/balance | Get User Balance *AccountApi* | getuserbillingcustomer | GET /v1/users/{userId}/billingCustomer | AccountApi | getuserupcomingbillinginvoice | GET /v1/users/{userId}/billingInvoices:getUpcoming | AccountApi | listgroupbillinginvoicelines | GET /v1/groups/{groupName}/billingInvoices/{billingInvoiceId}/lines | AccountApi | listgroupbillinginvoices | GET /v1/groups/{groupName}/billingInvoices | *AccountApi* | listgroupupcomingbillinginvoicelines | GET /v1/groups/{groupName}/billingInvoices:listUpcomingLines | AccountApi | listgroupusers | GET /v1/groups/{groupName}/users | List users belonging to a group AccountApi | listuserbillinginvoicelines | GET /v1/users/{userId}/billingInvoices/{billingInvoiceId}/lines | AccountApi | listuserbillinginvoices | GET /v1/users/{userId}/billingInvoices | *AccountApi* | listusergroups | GET /v1/users/{userId}/groups | List QCS groups for the requested user *AccountApi* | listuserupcomingbillinginvoicelines | GET /v1/users/{userId}/billingInvoices:listUpcomingLines | AccountApi | removegroupuser | POST /v1/groups:removeUser | Remove user from a group. AuthenticationApi | authemailpasswordresettoken | POST /v1/auth:emailPasswordResetToken | Email Password Reset Token AuthenticationApi | authgetuser | GET /v1/auth:getUser | Get User AuthenticationApi | authresetpassword | POST /v1/auth:resetPassword | Reset Password AuthenticationApi | authresetpasswordwithtoken | POST /v1/auth:resetPasswordWithToken | Reset Password With Token ClientApplicationsApi | checkclientapplication | POST /v1/clientApplications:check | Check Client Application ClientApplicationsApi | getclientapplication | GET /v1/clientApplications/{clientApplicationName} | Get Client Application ClientApplicationsApi | listclientapplications | GET /v1/clientApplications | List Client Applications DefaultApi | gethealth | GET / | *DefaultApi* | healthcheck | GET /v1/ | Health Check EndpointsApi | createendpoint | POST /v1/endpoints | Create Endpoint *EndpointsApi* | deleteendpoint | DELETE /v1/endpoints/{endpointId} | Delete Endpoint EndpointsApi | getdefaultendpoint | GET /v1/quantumProcessors/{quantumProcessorId}/endpoints:getDefault | Get Default Endpoint EndpointsApi | getendpoint | GET /v1/endpoints/{endpointId} | Get Endpoint *EndpointsApi* | listendpoints | GET /v1/endpoints | List Endpoints EndpointsApi | restartendpoint | POST /v1/endpoints/{endpointId}:restart | Restart Endpoint *EngagementsApi* | createengagement | POST /v1/engagements | Create Engagement QuantumProcessorsApi | getinstructionsetarchitecture | GET /v1/quantumProcessors/{quantumProcessorId}/instructionSetArchitecture | Get Instruction Set Architecture *QuantumProcessorsApi* | getquantumprocessor | GET /v1/quantumProcessors/{quantumProcessorId} | Get Quantum Processor *QuantumProcessorsApi* | listquantumprocessoraccessors | GET /v1/quantumProcessors/{quantumProcessorId}/accessors | List Quantum Processor Accessors QuantumProcessorsApi | listquantumprocessors | GET /v1/quantumProcessors | List Quantum Processors ReservationsApi | createreservation | POST /v1/reservations | Create Reservation *ReservationsApi* | deletereservation | DELETE /v1/reservations/{reservationId} | Delete Reservation ReservationsApi | findavailablereservations | GET /v1/reservations:findAvailable | Find Available Reservations ReservationsApi | listgroupreservations | GET /v1/groups/{groupName}/reservations | List Group Reservations ReservationsApi | listreservations | GET /v1/reservations | List Reservations *TranslationApi* | getquiltcalibrations | GET /v1/quantumProcessors/{quantumProcessorId}/quiltCalibrations | Get Quilt Calibrations *TranslationApi* | translatenativequiltoencryptedbinary | POST /v1/quantumProcessors/{quantumProcessorId}:translateNativeQuilToEncryptedBinary | Translate Native Quil To Encrypted Binary
To get access to the crate's generated documentation, use:
cargo doc --open
support@rigetti.com