QuTech API

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

list

GET /

Root endpoint - use one of sub endpoints.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["list"]
result = client.action(schema, action)

assets

list

GET /assets/

API endpoint that allows assets to be viewed or edited.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action assets list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["assets", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["assets", "list"]
result = client.action(schema, action)

create

POST /assets/

API endpoint that allows assets to be viewed or edited.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`contentType` required
`content`
`project` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action assets create -p name=... -p contentType=... -p content=... -p project=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["assets", "create"]
var params = {
    name: ...,
    contentType: ...,
    content: ...,
    project: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["assets", "create"]
params = {
    "name": ...,
    "contentType": ...,
    "content": ...,
    "project": ...,
}
result = client.action(schema, action, params=params)

read

GET /assets/{id}/

API endpoint that allows assets to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action assets read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["assets", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["assets", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /assets/{id}/

API endpoint that allows assets to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`contentType` required
`content`
`project` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action assets update -p id=... -p name=... -p contentType=... -p content=... -p project=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["assets", "update"]
var params = {
    id: ...,
    name: ...,
    contentType: ...,
    content: ...,
    project: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["assets", "update"]
params = {
    "id": ...,
    "name": ...,
    "contentType": ...,
    "content": ...,
    "project": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /assets/{id}/

API endpoint that allows assets to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`
`contentType`
`content`
`project`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action assets partial_update -p id=... -p name=... -p contentType=... -p content=... -p project=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["assets", "partial_update"]
var params = {
    id: ...,
    name: ...,
    contentType: ...,
    content: ...,
    project: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["assets", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "contentType": ...,
    "content": ...,
    "project": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /assets/{id}/

API endpoint that allows assets to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action assets delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["assets", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["assets", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

jobs > list

GET /assets/{id}/jobs/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action assets jobs list -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["assets", "jobs &gt; list"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["assets", "jobs &gt; list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

auth

token > create > create

POST /auth/token/create/

Use this endpoint to obtain user authentication token.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action auth token create create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "token &gt; create &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["auth", "token &gt; create &gt; create"]
result = client.action(schema, action)

token > destroy > create

POST /auth/token/destroy/

Use this endpoint to logout user (remove user authentication token).

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action auth token destroy create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "token &gt; destroy &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["auth", "token &gt; destroy &gt; create"]
result = client.action(schema, action)

backends

list

GET /backends/

API endpoint that allows backends to be viewed or edited.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backends list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backends", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backends", "list"]
result = client.action(schema, action)

create

POST /backends/

API endpoint that allows backends to be viewed or edited.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`location` required
`backend_type` required
`status` required
`status_message`
`lastHeartbeat`
`openqlPdf`
`account` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backends create -p name=... -p location=... -p backend_type=... -p status=... -p status_message=... -p lastHeartbeat=... -p openqlPdf=... -p account=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backends", "create"]
var params = {
    name: ...,
    location: ...,
    backend_type: ...,
    status: ...,
    status_message: ...,
    lastHeartbeat: ...,
    openqlPdf: ...,
    account: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backends", "create"]
params = {
    "name": ...,
    "location": ...,
    "backend_type": ...,
    "status": ...,
    "status_message": ...,
    "lastHeartbeat": ...,
    "openqlPdf": ...,
    "account": ...,
}
result = client.action(schema, action, params=params)

read

GET /backends/{id}/

API endpoint that allows backends to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backends read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backends", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backends", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /backends/{id}/

API endpoint that allows backends to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`location` required
`backend_type` required
`status` required
`status_message`
`lastHeartbeat`
`openqlPdf`
`account` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backends update -p id=... -p name=... -p location=... -p backend_type=... -p status=... -p status_message=... -p lastHeartbeat=... -p openqlPdf=... -p account=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backends", "update"]
var params = {
    id: ...,
    name: ...,
    location: ...,
    backend_type: ...,
    status: ...,
    status_message: ...,
    lastHeartbeat: ...,
    openqlPdf: ...,
    account: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backends", "update"]
params = {
    "id": ...,
    "name": ...,
    "location": ...,
    "backend_type": ...,
    "status": ...,
    "status_message": ...,
    "lastHeartbeat": ...,
    "openqlPdf": ...,
    "account": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /backends/{id}/

API endpoint that allows backends to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`
`location`
`backend_type`
`status`
`status_message`
`lastHeartbeat`
`openqlPdf`
`account`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backends partial_update -p id=... -p name=... -p location=... -p backend_type=... -p status=... -p status_message=... -p lastHeartbeat=... -p openqlPdf=... -p account=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backends", "partial_update"]
var params = {
    id: ...,
    name: ...,
    location: ...,
    backend_type: ...,
    status: ...,
    status_message: ...,
    lastHeartbeat: ...,
    openqlPdf: ...,
    account: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backends", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "location": ...,
    "backend_type": ...,
    "status": ...,
    "status_message": ...,
    "lastHeartbeat": ...,
    "openqlPdf": ...,
    "account": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /backends/{id}/

API endpoint that allows backends to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backends delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backends", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backends", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

calibration > list

GET /backends/{id}/calibration/

API endpoint that returns the latest calibration object for a specific backend. The list is sorted on the primary key from which the order is infered.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backends calibration list -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backends", "calibration &gt; list"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backends", "calibration &gt; list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

backendtypes

list

GET /backendtypes/

API endpoint that allows backends to be viewed or edited.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backendtypes list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backendtypes", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backendtypes", "list"]
result = client.action(schema, action)

read

GET /backendtypes/{id}/

API endpoint that allows backends to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backendtypes read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backendtypes", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backendtypes", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /backendtypes/{id}/

API endpoint that allows backends to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`is_hardware_backend`
`required_permission` required
`number_of_qubits` required
`description`
`topology` required
`chip_image_id`
`allowed_operations` required
`operations_count` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backendtypes update -p id=... -p name=... -p is_hardware_backend=... -p required_permission=... -p number_of_qubits=... -p description=... -p topology=... -p chip_image_id=... -p allowed_operations=... -p operations_count=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backendtypes", "update"]
var params = {
    id: ...,
    name: ...,
    is_hardware_backend: ...,
    required_permission: ...,
    number_of_qubits: ...,
    description: ...,
    topology: ...,
    chip_image_id: ...,
    allowed_operations: ...,
    operations_count: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backendtypes", "update"]
params = {
    "id": ...,
    "name": ...,
    "is_hardware_backend": ...,
    "required_permission": ...,
    "number_of_qubits": ...,
    "description": ...,
    "topology": ...,
    "chip_image_id": ...,
    "allowed_operations": ...,
    "operations_count": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /backendtypes/{id}/

API endpoint that allows backends to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`
`is_hardware_backend`
`required_permission`
`number_of_qubits`
`description`
`topology`
`chip_image_id`
`allowed_operations`
`operations_count`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backendtypes partial_update -p id=... -p name=... -p is_hardware_backend=... -p required_permission=... -p number_of_qubits=... -p description=... -p topology=... -p chip_image_id=... -p allowed_operations=... -p operations_count=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backendtypes", "partial_update"]
var params = {
    id: ...,
    name: ...,
    is_hardware_backend: ...,
    required_permission: ...,
    number_of_qubits: ...,
    description: ...,
    topology: ...,
    chip_image_id: ...,
    allowed_operations: ...,
    operations_count: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backendtypes", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "is_hardware_backend": ...,
    "required_permission": ...,
    "number_of_qubits": ...,
    "description": ...,
    "topology": ...,
    "chip_image_id": ...,
    "allowed_operations": ...,
    "operations_count": ...,
}
result = client.action(schema, action, params=params)

calibration > list

GET /backendtypes/{id}/calibration/

API endpoint that returns the last calibration object, independent on the backend it comes from, for a backendtype.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backendtypes calibration list -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backendtypes", "calibration &gt; list"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backendtypes", "calibration &gt; list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

default > list

GET /backendtypes/default/

API endpoint that returns the QX single-node simulator as the default backend

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action backendtypes default list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["backendtypes", "default &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["backendtypes", "default &gt; list"]
result = client.action(schema, action)

calibration

create

POST /calibration/

API endpoint that allows the backend owner to store calibration parameters for its backend. The coreapi functions 'edit', 'list' and 'destroy' are not allowed.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`parameters` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action calibration create -p parameters=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["calibration", "create"]
var params = {
    parameters: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["calibration", "create"]
params = {
    "parameters": ...,
}
result = client.action(schema, action, params=params)

read

GET /calibration/{id}/

API endpoint that allows the backend owner to store calibration parameters for its backend. The coreapi functions 'edit', 'list' and 'destroy' are not allowed.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action calibration read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["calibration", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["calibration", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

email

broadcast > create

POST /email/broadcast/

View for the Broadcast function in which an admin can send a markdown styled email to all the users in either elaborate_user or basic_user group. This email is sent from the BROADCAST_EMAIL_TO address that is specified in the settings.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`subject` required
`markdown` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action email broadcast create -p subject=... -p markdown=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["email", "broadcast &gt; create"]
var params = {
    subject: ...,
    markdown: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["email", "broadcast &gt; create"]
params = {
    "subject": ...,
    "markdown": ...,
}
result = client.action(schema, action, params=params)

confirm > create

POST /email/confirm/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`uid` required
`token` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action email confirm create -p uid=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["email", "confirm &gt; create"]
var params = {
    uid: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["email", "confirm &gt; create"]
params = {
    "uid": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

groups

list

GET /groups/

API endpoint that allows groups to be viewed or edited.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action groups list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["groups", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["groups", "list"]
result = client.action(schema, action)

read

GET /groups/{id}/

API endpoint that allows groups to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action groups read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["groups", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["groups", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

jobs

list

GET /jobs/

API endpoint that allows jobs to be viewed and created.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`status`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs list -p status=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "list"]
var params = {
    status: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "list"]
params = {
    "status": ...,
}
result = client.action(schema, action, params=params)

create

POST /jobs/

To create a job set the status to NEW, do not set the BACKEND field, and set the backend_type to one of the available backends. The input is an asset in the database in the form of an URL.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`status`
`input` required
`backend`
`backend_type` required
`number_of_shots` required
`full_state_projection`
`user_data`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs create -p name=... -p status=... -p input=... -p backend=... -p backend_type=... -p number_of_shots=... -p full_state_projection=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "create"]
var params = {
    name: ...,
    status: ...,
    input: ...,
    backend: ...,
    backend_type: ...,
    number_of_shots: ...,
    full_state_projection: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "create"]
params = {
    "name": ...,
    "status": ...,
    "input": ...,
    "backend": ...,
    "backend_type": ...,
    "number_of_shots": ...,
    "full_state_projection": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

read

GET /jobs/{id}/

API endpoint that allows jobs to be viewed and created.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`status`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs read -p id=... -p status=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "read"]
var params = {
    id: ...,
    status: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "read"]
params = {
    "id": ...,
    "status": ...,
}
result = client.action(schema, action, params=params)

update

PUT /jobs/{id}/

API endpoint that allows jobs to be viewed and created.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`status`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`status`
`input` required
`backend`
`backend_type` required
`number_of_shots` required
`full_state_projection`
`user_data`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs update -p id=... -p name=... -p status=... -p input=... -p backend=... -p backend_type=... -p number_of_shots=... -p full_state_projection=... -p user_data=... -p status=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "update"]
var params = {
    id: ...,
    name: ...,
    status: ...,
    input: ...,
    backend: ...,
    backend_type: ...,
    number_of_shots: ...,
    full_state_projection: ...,
    user_data: ...,
    status: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "update"]
params = {
    "id": ...,
    "name": ...,
    "status": ...,
    "input": ...,
    "backend": ...,
    "backend_type": ...,
    "number_of_shots": ...,
    "full_state_projection": ...,
    "user_data": ...,
    "status": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /jobs/{id}/

API endpoint that allows jobs to be viewed and created.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`status`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`
`status`
`input`
`backend`
`backend_type`
`number_of_shots`
`full_state_projection`
`user_data`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs partial_update -p id=... -p name=... -p status=... -p input=... -p backend=... -p backend_type=... -p number_of_shots=... -p full_state_projection=... -p user_data=... -p status=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "partial_update"]
var params = {
    id: ...,
    name: ...,
    status: ...,
    input: ...,
    backend: ...,
    backend_type: ...,
    number_of_shots: ...,
    full_state_projection: ...,
    user_data: ...,
    status: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "status": ...,
    "input": ...,
    "backend": ...,
    "backend_type": ...,
    "number_of_shots": ...,
    "full_state_projection": ...,
    "user_data": ...,
    "status": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /jobs/{id}/

Allows to delete a job

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`status`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs delete -p id=... -p status=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "delete"]
var params = {
    id: ...,
    status: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "delete"]
params = {
    "id": ...,
    "status": ...,
}
result = client.action(schema, action, params=params)

cancel > partial_update

PATCH /jobs/{id}/cancel/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs cancel partial_update -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "cancel &gt; partial_update"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "cancel &gt; partial_update"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

complete > partial_update

PATCH /jobs/{id}/complete/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs complete partial_update -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "complete &gt; partial_update"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "complete &gt; partial_update"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

paginated > list

GET /jobs/paginated/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.
`status`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs paginated list -p page=... -p page_size=... -p status=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "paginated &gt; list"]
var params = {
    page: ...,
    page_size: ...,
    status: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "paginated &gt; list"]
params = {
    "page": ...,
    "page_size": ...,
    "status": ...,
}
result = client.action(schema, action, params=params)

pre-flight > create

POST /jobs/pre-flight/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`status`
`input` required
`backend`
`backend_type` required
`number_of_shots` required
`full_state_projection`
`user_data`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs pre-flight create -p name=... -p status=... -p input=... -p backend=... -p backend_type=... -p number_of_shots=... -p full_state_projection=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "pre-flight &gt; create"]
var params = {
    name: ...,
    status: ...,
    input: ...,
    backend: ...,
    backend_type: ...,
    number_of_shots: ...,
    full_state_projection: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "pre-flight &gt; create"]
params = {
    "name": ...,
    "status": ...,
    "input": ...,
    "backend": ...,
    "backend_type": ...,
    "number_of_shots": ...,
    "full_state_projection": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

result > list

GET /jobs/{id}/result/

API endpoint that lists results for a job.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs result list -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "result &gt; list"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "result &gt; list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

take > partial_update

PATCH /jobs/take/

API endpoint that assigns a job to the signed-in backend user and return the job data in the response. If a job is already assigned, that job data will be returned.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jobs take partial_update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "take &gt; partial_update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jobs", "take &gt; partial_update"]
result = client.action(schema, action)

jwt

create

POST /jwt/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required
`password` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jwt create -p username=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jwt", "create"]
var params = {
    username: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jwt", "create"]
params = {
    "username": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

refresh > create

POST /jwt/refresh/

API View that returns a refreshed token (with new expiration) based on existing token

If 'orig_iat' field (original issued-at-time) is found, will first check if it's within expiration window, then copy it to the new token

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`token` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jwt refresh create -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jwt", "refresh &gt; create"]
var params = {
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jwt", "refresh &gt; create"]
params = {
    "token": ...,
}
result = client.action(schema, action, params=params)

verify > create

POST /jwt/verify/

API View that checks the veracity of a token, returning the token if it is valid.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`token` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action jwt verify create -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jwt", "verify &gt; create"]
var params = {
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["jwt", "verify &gt; create"]
params = {
    "token": ...,
}
result = client.action(schema, action, params=params)

me

read

GET /me/

Customize the authentication classes allowed for the me endpoint

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action me read

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["me", "read"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["me", "read"]
result = client.action(schema, action)

update

PUT /me/

Customize the authentication classes allowed for the me endpoint

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`full_name` required	Required. 1024 characters or fewer.
`email` required
`password` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action me update -p username=... -p full_name=... -p email=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["me", "update"]
var params = {
    username: ...,
    full_name: ...,
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["me", "update"]
params = {
    "username": ...,
    "full_name": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /me/

Customize the authentication classes allowed for the me endpoint

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username`	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`full_name`	Required. 1024 characters or fewer.
`email`
`password`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action me partial_update -p username=... -p full_name=... -p email=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["me", "partial_update"]
var params = {
    username: ...,
    full_name: ...,
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["me", "partial_update"]
params = {
    "username": ...,
    "full_name": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

password

create

POST /password/

Customize the authentication classes allowed for the set_password endpoint

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`new_password` required
`re_new_password` required
`current_password` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action password create -p new_password=... -p re_new_password=... -p current_password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["password", "create"]
var params = {
    new_password: ...,
    re_new_password: ...,
    current_password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["password", "create"]
params = {
    "new_password": ...,
    "re_new_password": ...,
    "current_password": ...,
}
result = client.action(schema, action, params=params)

reset > create

POST /password/reset/

Use this endpoint to send email to user with password reset link.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action password reset create -p email=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["password", "reset &gt; create"]
var params = {
    email: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["password", "reset &gt; create"]
params = {
    "email": ...,
}
result = client.action(schema, action, params=params)

reset > confirm > create

POST /password/reset/confirm/

Use this endpoint to finish reset password process.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`uid` required
`token` required
`new_password` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action password reset confirm create -p uid=... -p token=... -p new_password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["password", "reset &gt; confirm &gt; create"]
var params = {
    uid: ...,
    token: ...,
    new_password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["password", "reset &gt; confirm &gt; create"]
params = {
    "uid": ...,
    "token": ...,
    "new_password": ...,
}
result = client.action(schema, action, params=params)

projects

list

GET /projects/

API endpoint that allows projects to be viewed or edited.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action projects list -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "list"]
var params = {
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["projects", "list"]
params = {
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

create

POST /projects/

API endpoint that allows projects to be viewed or edited.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`backend_type` required
`default_number_of_shots` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action projects create -p name=... -p backend_type=... -p default_number_of_shots=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "create"]
var params = {
    name: ...,
    backend_type: ...,
    default_number_of_shots: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["projects", "create"]
params = {
    "name": ...,
    "backend_type": ...,
    "default_number_of_shots": ...,
}
result = client.action(schema, action, params=params)

read

GET /projects/{id}/

API endpoint that allows projects to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action projects read -p id=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "read"]
var params = {
    id: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["projects", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

update

PUT /projects/{id}/

API endpoint that allows projects to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`backend_type` required
`default_number_of_shots` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action projects update -p id=... -p name=... -p backend_type=... -p default_number_of_shots=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "update"]
var params = {
    id: ...,
    name: ...,
    backend_type: ...,
    default_number_of_shots: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["projects", "update"]
params = {
    "id": ...,
    "name": ...,
    "backend_type": ...,
    "default_number_of_shots": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /projects/{id}/

API endpoint that allows projects to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`
`backend_type`
`default_number_of_shots`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action projects partial_update -p id=... -p name=... -p backend_type=... -p default_number_of_shots=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "partial_update"]
var params = {
    id: ...,
    name: ...,
    backend_type: ...,
    default_number_of_shots: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["projects", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "backend_type": ...,
    "default_number_of_shots": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /projects/{id}/

API endpoint that allows projects to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action projects delete -p id=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "delete"]
var params = {
    id: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["projects", "delete"]
params = {
    "id": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

assets > list

GET /projects/{id}/assets/

API endpoint that lists assets for a project.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action projects assets list -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "assets &gt; list"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["projects", "assets &gt; list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

jobs > list

GET /projects/{id}/jobs/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`status`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action projects jobs list -p id=... -p status=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "jobs &gt; list"]
var params = {
    id: ...,
    status: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["projects", "jobs &gt; list"]
params = {
    "id": ...,
    "status": ...,
}
result = client.action(schema, action, params=params)

jobs > paginated > list

GET /projects/{id}/jobs/paginated/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.
`status`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action projects jobs paginated list -p id=... -p page=... -p page_size=... -p status=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "jobs &gt; paginated &gt; list"]
var params = {
    id: ...,
    page: ...,
    page_size: ...,
    status: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["projects", "jobs &gt; paginated &gt; list"]
params = {
    "id": ...,
    "page": ...,
    "page_size": ...,
    "status": ...,
}
result = client.action(schema, action, params=params)

paginated > list

GET /projects/paginated/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.
`ordering`	Which field to use when ordering the results.
`search`	A search term.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action projects paginated list -p page=... -p page_size=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "paginated &gt; list"]
var params = {
    page: ...,
    page_size: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["projects", "paginated &gt; list"]
params = {
    "page": ...,
    "page_size": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

queue

list

GET /queue/

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action queue list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["queue", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["queue", "list"]
result = client.action(schema, action)

results

list

GET /results/

API endpoint that allows results to be viewed or edited.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action results list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["results", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["results", "list"]
result = client.action(schema, action)

create

POST /results/

API endpoint that allows results to be viewed or edited.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`job` required
`number_of_qubits`
`execution_time_in_seconds`
`raw_text`
`raw_data`
`histogram`
`measurement_mask`
`quantum_states`
`measurement_register`
`calibration`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action results create -p job=... -p number_of_qubits=... -p execution_time_in_seconds=... -p raw_text=... -p raw_data=... -p histogram=... -p measurement_mask=... -p quantum_states=... -p measurement_register=... -p calibration=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["results", "create"]
var params = {
    job: ...,
    number_of_qubits: ...,
    execution_time_in_seconds: ...,
    raw_text: ...,
    raw_data: ...,
    histogram: ...,
    measurement_mask: ...,
    quantum_states: ...,
    measurement_register: ...,
    calibration: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["results", "create"]
params = {
    "job": ...,
    "number_of_qubits": ...,
    "execution_time_in_seconds": ...,
    "raw_text": ...,
    "raw_data": ...,
    "histogram": ...,
    "measurement_mask": ...,
    "quantum_states": ...,
    "measurement_register": ...,
    "calibration": ...,
}
result = client.action(schema, action, params=params)

read

GET /results/{id}/

API endpoint that allows results to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action results read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["results", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["results", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

histogram > read

GET /results/{id}/histogram/{token}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required
`token` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action results histogram read -p id=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["results", "histogram &gt; read"]
var params = {
    id: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["results", "histogram &gt; read"]
params = {
    "id": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

measurement-register > read

GET /results/{id}/measurement-register/{token}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required
`token` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action results measurement-register read -p id=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["results", "measurement-register &gt; read"]
var params = {
    id: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["results", "measurement-register &gt; read"]
params = {
    "id": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

paginated > list

GET /results/paginated/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action results paginated list -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["results", "paginated &gt; list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["results", "paginated &gt; list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

quantum-states > read

GET /results/{id}/quantum-states/{token}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required
`token` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action results quantum-states read -p id=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["results", "quantum-states &gt; read"]
var params = {
    id: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["results", "quantum-states &gt; read"]
params = {
    "id": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

raw-data > read

GET /results/{id}/raw-data/{token}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required
`token` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action results raw-data read -p id=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["results", "raw-data &gt; read"]
var params = {
    id: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["results", "raw-data &gt; read"]
params = {
    "id": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

statistics

backendtype > list

GET /statistics/backendtype/

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action statistics backendtype list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["statistics", "backendtype &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["statistics", "backendtype &gt; list"]
result = client.action(schema, action)

user > list

GET /statistics/user/

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action statistics user list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["statistics", "user &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["statistics", "user &gt; list"]
result = client.action(schema, action)

username

create

POST /username/

Customize the authentication classes allowed for the set_username endpoint

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`current_password` required
`new_username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action username create -p current_password=... -p new_username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["username", "create"]
var params = {
    current_password: ...,
    new_username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["username", "create"]
params = {
    "current_password": ...,
    "new_username": ...,
}
result = client.action(schema, action, params=params)

users

list

GET /users/

API endpoint that allows users to be viewed or edited.

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "list"]
result = client.action(schema, action)

read

GET /users/{id}/

API endpoint that allows users to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /users/{id}/

API endpoint that allows users to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`full_name` required	Required. 1024 characters or fewer.
`email` required
`password` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users update -p id=... -p username=... -p full_name=... -p email=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "update"]
var params = {
    id: ...,
    username: ...,
    full_name: ...,
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "update"]
params = {
    "id": ...,
    "username": ...,
    "full_name": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /users/{id}/

API endpoint that allows users to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username`	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`full_name`	Required. 1024 characters or fewer.
`email`
`password`

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users partial_update -p id=... -p username=... -p full_name=... -p email=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "partial_update"]
var params = {
    id: ...,
    username: ...,
    full_name: ...,
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "partial_update"]
params = {
    "id": ...,
    "username": ...,
    "full_name": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

activate > create

POST /users/activate/

Use this endpoint to activate user account.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`uid` required
`token` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users activate create -p uid=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "activate &gt; create"]
var params = {
    uid: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "activate &gt; create"]
params = {
    "uid": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

create > create

POST /users/create/

Use this endpoint to register new user.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`full_name` required	Required. 1024 characters or fewer.
`email` required
`password` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users create create -p username=... -p full_name=... -p email=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "create &gt; create"]
var params = {
    username: ...,
    full_name: ...,
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "create &gt; create"]
params = {
    "username": ...,
    "full_name": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

create > anonymous > create

POST /users/create/anonymous/

API endpoint that allows to create an anonymous user and returns a valid JWT token

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users create anonymous create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "create &gt; anonymous &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "create &gt; anonymous &gt; create"]
result = client.action(schema, action)

delete > create

POST /users/delete/

Use this endpoint to remove actually authenticated user

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`current_password` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users delete create -p current_password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "delete &gt; create"]
var params = {
    current_password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "delete &gt; create"]
params = {
    "current_password": ...,
}
result = client.action(schema, action, params=params)

resend > create

POST /users/resend/

Use this endpoint to resend user activation email.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users resend create -p email=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "resend &gt; create"]
var params = {
    email: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "resend &gt; create"]
params = {
    "email": ...,
}
result = client.action(schema, action, params=params)

upgrade > create

POST /users/upgrade/

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users upgrade create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "upgrade &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "upgrade &gt; create"]
result = client.action(schema, action)

upgrade > anonymous > update

PUT /users/upgrade/anonymous/

# Load the schema document
$ coreapi get https://staging.quantum-inspire.com/docs/

# Interact with the API endpoint
$ coreapi action users upgrade anonymous update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "upgrade &gt; anonymous &gt; update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://staging.quantum-inspire.com/docs/")

# Interact with the API endpoint
action = ["users", "upgrade &gt; anonymous &gt; update"]
result = client.action(schema, action)