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 & Co engagements API

The Engagement is the authorization mechanism for access to the Quantum Processor.

Rigetti & Co engagements API is one of 9 APIs that Rigetti & Co publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include engagements. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 6 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.

1 operations 1 paths 6 schemas 1 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 & Co engagements 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

engagements 1

The Engagement is the authorization mechanism for access to the Quantum Processor.

POST
/v1/engagements
Create Engagement
CreateEngagement 2 params body → 200400404422503

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are EngagementWithCredentials (10 properties), CreateEngagementRequest (5 properties), Error (4 properties), EngagementCredentials (3 properties). Each schema is shown below with its type and property counts.

ValidationError
object
3 properties 2 required
Error
object
4 properties 3 required
AccountType
string
There are two types of accounts within QCS: user (representing a single user in Okta) and group (representing one or more users in Okta).
EngagementWithCredentials
object
An engagement is the authorization of a user to execute work on a Quantum Processor Endpoint.
10 properties 5 required
EngagementCredentials
object
Credentials are the ZeroMQ CURVE Keys used to encrypt the connection with the Quantum Processor Endpoint.
3 properties 3 required
CreateEngagementRequest
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rigetti-and-co-engagements-api-openapi.yml Raw ↑

Other APIs Rigetti & Co publishes across the network.

Rigetti & Co account API
Rigetti & Co authentication API
Rigetti & Co clientApplications API
Rigetti & Co endpoints API
Rigetti & Co Healthcheck API
Rigetti & Co quantumProcessors API
Rigetti & Co reservations API
Rigetti & Co Rigetti QCS API API