Rigetti & Co Engagements API
The Engagement is the authorization mechanism for access to the Quantum Processor.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/rigetti-and-co-engagements-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
x-logo: https://qcs.rigetti.com/static/img/rigetti-logo.svg
contact:
email: support@rigetti.com
url: https://rigetti.zendesk.com
title: Rigetti QCS Engagements API
version: 2020-07-31
description: '# Introduction
This is the documentation for the Rigetti QCS HTTP API.'
servers:
- description: Rigetti API
url: https://api.qcs.rigetti.com
tags:
- description: The Engagement is the authorization mechanism for access to the Quantum Processor.
name: Engagements
x-displayName: Engagements
paths:
/v1/engagements:
post:
description: 'Create a new engagement using the specified parameters.
At least one of the following parameters must be supplied:
- **endpointId**: The ID of the endpoint on which to engage.
- **quantumProcessorId**: The ID of the quantum processor on which to engage, allowing the
service to select a default endpoint. Ignored if **endpointId** is set.'
operationId: CreateEngagement
parameters:
- description: Either the client's user ID or the name of a group on behalf of which the client wishes to engage. May be overriden by accountId set in body.
in: header
name: x-qcs-account-id
required: false
schema:
description: Either the client's user ID or the name of a group on behalf of which the client wishes to engage. May be overriden by accountId set in body.
title: X-Qcs-Account-Id
type: string
- description: Indicates whether the engagement request should be made for the user or on behalf of a group. May be overriden by accountType set in body.
in: header
name: x-qcs-account-type
required: false
schema:
allOf:
- $ref: '#/components/schemas/AccountType'
description: Indicates whether the engagement request should be made for the user or on behalf of a group. May be overriden by accountType set in body.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEngagementRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EngagementWithCredentials'
description: Successful Response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Validation error
'503':
description: Endpoint is temporarily unavailable, try again later.
headers:
Retry-After:
description: Number of seconds to wait before retrying
schema:
type: integer
security:
- JWTBearer: []
summary: Create Engagement
tags:
- Engagements
components:
schemas:
EngagementWithCredentials:
description: An engagement is the authorization of a user to execute work on a Quantum Processor Endpoint.
properties:
accountId:
description: User ID or group name on behalf of which the engagement is made.
title: Account Id
type: string
accountType:
allOf:
- $ref: '#/components/schemas/AccountType'
description: Indicates whether the grant was made on behalf of a single user or group.
title: Account Type
address:
description: The network address of the endpoint to which this engagement grants access
title: Address
type: string
credentials:
$ref: '#/components/schemas/EngagementCredentials'
endpointId:
description: The ID of the endpoint to which this engagement grants access
title: Endpoint ID
type: string
expiresAt:
description: Time after which the engagement is no longer valid. Given in RFC3339 format.
title: Expiration Time
type: string
minimumPriority:
description: The minimum priority value allowed for execution
title: Minimum Priority
type: integer
quantumProcessorIds:
default: []
description: The quantum processors for which this engagement enables access and execution
items:
type: string
title: Quantum Processor IDs
type: array
tags:
description: Tags recorded on QPU requests and recorded on usage records.
items:
type: string
title: Tags
type: array
userId:
title: User ID of client
type: string
required:
- address
- endpointId
- expiresAt
- userId
- credentials
title: EngagementWithCredentials
type: object
Error:
properties:
code:
title: Code
type: string
message:
title: Message
type: string
requestId:
title: Request ID
type: string
validationErrors:
items:
$ref: '#/components/schemas/ValidationError'
title: Validation Errors
type: array
required:
- code
- message
- requestId
title: Error
type: object
AccountType:
description: 'There are two types of accounts within QCS: user (representing a single user in Okta) and group (representing one or more users in Okta).'
default: user
enum:
- group
- user
type: string
EngagementCredentials:
description: 'Credentials are the ZeroMQ CURVE Keys used to encrypt the connection with the Quantum Processor
Endpoint.'
properties:
clientPublic:
title: Client Public Key
type: string
clientSecret:
title: Client Secret Key
type: string
serverPublic:
title: Server Public Key
type: string
required:
- clientPublic
- clientSecret
- serverPublic
title: EngagementCredentials
type: object
ValidationError:
properties:
in:
enum:
- header
- query
- path
- body
type: string
message:
title: Message
type: string
path:
items:
type: string
title: Path
type: array
required:
- in
- message
title: ValidationError
type: object
CreateEngagementRequest:
properties:
accountId:
description: Either the client's user ID or the name of a group on behalf of which the client wishes to engage. This value will override any values set in the headers.
title: Account Id
type: string
accountType:
allOf:
- $ref: '#/components/schemas/AccountType'
description: Indicates whether the engagement request should be made for the user or on behalf of a group. This value will override any values set in the headers.
title: Account Type
endpointId:
description: Unique, opaque identifier for the endpoint
title: Endpoint ID
type: string
quantumProcessorId:
description: 'Public identifier for a quantum processor [example: Aspen-1]'
title: Quantum Processor ID
type: string
tags:
description: Tags recorded on QPU requests, which reporting services may later use for querying usage records.
items:
type: string
title: Tags
type: array
title: CreateEngagementRequest
type: object
securitySchemes:
JWTBearer:
bearerFormat: JWT
description: 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 token is valid, the server uses the claims to authorize the request, which may result in a 403 response.
scheme: bearer
type: http
JWTBearerOptional:
bearerFormat: JWT
description: 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, the server authorizes the request against either the valid token claims or an unauthenticated user. In either case, the client may receive a 403 response.
scheme: bearer
type: http
x-tagGroups:
- name: Account Management
tags:
- account
- authentication
- name: QPU Access
tags:
- endpoints
- deployments
- engagements
- quantumProcessors
- reservations
- translation
- name: SDKs
tags:
- clientApplications
- name: Filtering and ordering
tags:
- filterParameter
- orderParameter
- name: Errors
tags:
- errors