Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rigetti Computing endpoints API

The Endpoint is the means of access to a Quantum Processor.

Rigetti Computing endpoints API is one of 11 APIs that Rigetti Computing publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include endpoints. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.2, at version 2020-07-31.

Requests are made against a single base URL, https://api.qcs.rigetti.com.

6 operations 4 paths 8 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
2020-07-31
Base URL
https://api.qcs.rigetti.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Rigetti Computing endpoints API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (JWTBearer). It accepts HTTP bearer tokens (JWT) (JWTBearerOptional).

  • JWTBearer — A JSON web token with sub or uid claim, as well as groups claim. If the token is absent, invalid or expired, the client will receive a 401 response. If the tok…
  • JWTBearerOptional — Same as JWTBearer, but the Authorization header is optionally parsed. Clients will receive a 401 response if an invalid or expired token is provided. Otherwise…

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

endpoints 6

The Endpoint is the means of access to a Quantum Processor.

GET
/v1/endpoints
List Endpoints
ListEndpoints 3 params → 200422
POST
/v1/endpoints
Create Endpoint
CreateEndpoint body → 201400404422
DELETE
/v1/endpoints/{endpointId}
Delete Endpoint
DeleteEndpoint 1 param → 204403404422
GET
/v1/endpoints/{endpointId}
Get Endpoint
GetEndpoint 1 param → 200404422
POST
/v1/endpoints/{endpointId}:restart
Restart Endpoint
RestartEndpoint 1 param body → 204403422
GET
/v1/quantumProcessors/{quantumProcessorId}/endpoints:getDefault
Get Default Endpoint
GetDefaultEndpoint 1 param → 200404422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Endpoint (7 properties), Error (4 properties), ValidationError (3 properties), EndpointAddresses (2 properties). Each schema is shown below with its type and property counts.

CreateEndpointParameters
object
A publicly available set of parameters for defining an endpoint.
2 properties
RestartEndpointRequest
object
1 property
ListEndpointsResponse
object
2 properties 1 required
ValidationError
object
3 properties 2 required
Endpoint
object
An Endpoint is the entry point for remote access to a QuantumProcessor.
7 properties 4 required
Error
object
4 properties 3 required
NomadJobDatacenters
string
An enumeration.
EndpointAddresses
object
Addresses at which an endpoint is reachable over the network.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rigetti-endpoints-api-openapi.yml Raw ↑

Other APIs Rigetti Computing publishes across the network.

Rigetti QCS Translation Service (gRPC)
Rigetti QCS Controller Service (gRPC)
Rigetti Computing account API
Rigetti Computing authentication API
Rigetti Computing clientApplications API
Rigetti Computing engagements API
Rigetti Computing Healthcheck API
Rigetti Computing quantumProcessors API
Rigetti Computing reservations API
Rigetti Computing Rigetti QCS API API