Skip to main content
API docs by Redocly

Public API (v1)

Download OpenAPI specification:Download

Get authenticated user's information.

Get authenticated user's information.

Responses

Update authenticated user.

Update authenticated user.

Request Body schema: application/json
family_name
string
Default: ""
given_name
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "family_name": "",
  • "given_name": ""
}

Onboard user by accepting community terms and cond

Onboard user by accepting community terms and conditions.

Request Body schema: application/json
family_name
required
string
given_name
required
string

Responses

Request samples

Content type
application/json
{
  • "family_name": "string",
  • "given_name": "string"
}

Onboard user by accepting compute terms and condit

Onboard user by accepting compute terms and conditions.

Request Body schema: application/json
family_name
required
string
given_name
required
string

Responses

Request samples

Content type
application/json
{
  • "family_name": "string",
  • "given_name": "string"
}

Register azure connectors account to Microsot Azur

Register azure connectors account to Microsot Azure project.

Register a request made by the user to access comp

Register a request made by the user to access compute platform.

Request Body schema: application/json
message
required
string

Responses

Request samples

Content type
application/json
{
  • "message": "string"
}

Get or create a learner for the user.

Get or create a learner for the user.

path Parameters
package
required
string

Responses

Update a community learner for the user.

Update a community learner for the user.

path Parameters
package
required
string
Request Body schema: application/json
required
object
property name*
additional property
string
Enum: "DONE" "SKIP" "IN_PROGRESS"

Responses

Request samples

Content type
application/json
{
  • "progress": {
    }
}

/api/v1/ping

/api/v1/projects/{project_id}/service-account

path Parameters
project_id
required
string

project

Get the list of the projects you are a member of o

Get the list of the projects you are a member of or are invited to.

query Parameters
limit
integer [ 0 .. 100 ]
Default: 100
offset
integer
order_by
string
order_by_direction
string
Enum: "ASC" "DESC"

Responses

Create new project.

Create new project.

Request Body schema: application/json
account_manager_id
required
string

ID of the account manager

Array of objects (ConsumedAdditionalAccessGrant)
admin_email
required
string <email>

Email of the first admin to add to the project.

allowed_device_types
Array of strings
Items Enum: "EMU_FREE" "EMU_SV" "EMU_TN" "EMU_C" "FRESNEL" "EMU_FRESNEL" "EMU_MPS"

A list of DeviceType the project can use

company
required
string
description
string or null
email_domain
string or null
name
required
string
package
required
string
Enum: "QUANTUM_DISCOVERY" "QUANTUM_DISCOVERY_CHEMISTRY" "QUANTUM_DISCOVERY_LIGHT" "QUANTUM_DISCOVERY_PLAY" "QUANTUM_DISCOVERY_ESSENTIAL" "LEARN_BY_CODING" "VQPU"

Package of the project.

project_type
string
Enum: "INTERNAL" "CLIENT" "ACADEMIC"

the type of project account managers or support members are working on

queue_priority
string
Enum: "LOW" "MEDIUM" "HIGH"

A value representing the priority the associated batches are scheduled

Responses

Request samples

Content type
application/json
{
  • "account_manager_id": "string",
  • "additional_access_grants": [
    ],
  • "admin_email": "user@example.com",
  • "allowed_device_types": [
    ],
  • "company": "string",
  • "description": "string",
  • "email_domain": "string",
  • "name": "string",
  • "package": "QUANTUM_DISCOVERY",
  • "project_type": "INTERNAL",
  • "queue_priority": "LOW"
}

Get list of potential account managers for the pro

Get list of potential account managers for the project.

query Parameters
limit
integer [ 0 .. 100 ]
Default: 100
offset
integer
order_by
string
order_by_direction
string
Enum: "ASC" "DESC"

Responses

Get list of all active members from all projects u

Get list of all active members from all projects user belongs to.

Responses

Get a project you are member of or are invited to.

Get a project you are member of or are invited to.

path Parameters
project_id
required
string
query Parameters
enrich_with_account_data
boolean
Default: true

Responses

Update a project.

Update a project.

path Parameters
project_id
required
string
Request Body schema: application/json
company
string
description
string or null
name
string
package
string
Enum: "QUANTUM_DISCOVERY" "QUANTUM_DISCOVERY_CHEMISTRY" "QUANTUM_DISCOVERY_LIGHT" "QUANTUM_DISCOVERY_PLAY" "QUANTUM_DISCOVERY_ESSENTIAL" "LEARN_BY_CODING" "VQPU"

Package of the project.

Responses

Request samples

Content type
application/json
{
  • "company": "string",
  • "description": "string",
  • "name": "string",
  • "package": "QUANTUM_DISCOVERY"
}

Accept an invitation to a project.

Accept an invitation to a project.

path Parameters
project_id
required
string

Responses

Check whether a user has the right access_grants t

Check whether a user has the right access_grants to execute an operation on a project

path Parameters
project_id
required
string
query Parameters
authorizations
required
Array of strings
Items Enum: "usecase:submit" "test:1" "test:2" "test:3"
subject_id
required
string

Responses

Update additional access grants on a given project

Update additional access grants on a given project. Requires superuser credentials.

path Parameters
project_id
required
string
Request Body schema: application/json
Array of objects (ConsumedAdditionalAccessGrant)
Array
grant
required
string
Enum: "usecase:submit" "test:1" "test:2" "test:3"
role
required
string
Enum: "ADMIN" "MEMBER"

Responses

Request samples

Content type
application/json
{
  • "additional_access_grants": [
    ]
}

Leave a project.

Leave a project.

path Parameters
project_id
required
string

Responses

Update project as manager.

Update project as manager.

path Parameters
project_id
required
string
Request Body schema: application/json
account_manager_id
string

ID of the account manager

Array of objects (ConsumedAdditionalAccessGrant)
allowed_device_types
Array of strings
Items Enum: "EMU_FREE" "EMU_SV" "EMU_TN" "EMU_C" "FRESNEL" "EMU_FRESNEL" "EMU_MPS"

A list of DeviceType the project can use

company
string
description
string or null
name
string
package
string
Enum: "QUANTUM_DISCOVERY" "QUANTUM_DISCOVERY_CHEMISTRY" "QUANTUM_DISCOVERY_LIGHT" "QUANTUM_DISCOVERY_PLAY" "QUANTUM_DISCOVERY_ESSENTIAL" "LEARN_BY_CODING" "VQPU"

Package of the project.

project_type
string
Enum: "INTERNAL" "CLIENT" "ACADEMIC"

the type of project account managers or support members are working on

queue_priority
string
Enum: "LOW" "MEDIUM" "HIGH"

A value representing the priority the associated batches are scheduled

Responses

Request samples

Content type
application/json
{
  • "account_manager_id": "string",
  • "additional_access_grants": [
    ],
  • "allowed_device_types": [
    ],
  • "company": "string",
  • "description": "string",
  • "name": "string",
  • "package": "QUANTUM_DISCOVERY",
  • "project_type": "INTERNAL",
  • "queue_priority": "LOW"
}

Remove members from a project.

Remove members from a project.

path Parameters
project_id
required
string
Request Body schema: application/json
user_ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "user_ids": [
    ]
}

Get members of a project.

Get members of a project.

path Parameters
project_id
required
string
query Parameters
limit
integer [ 0 .. 100 ]
Default: 100
offset
integer
order_by
string
order_by_direction
string
Enum: "ASC" "DESC"

Responses

Add or update members for a project. When an email

Add or update members for a project. When an email address is not found invite it.

path Parameters
project_id
required
string
Request Body schema: application/json
emails
required
Array of strings <email> [ items <email > ]
role
string
Enum: "ADMIN" "MEMBER"

Role of the member.

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "role": "ADMIN"
}

Update existing members for a project.

Update existing members for a project.

path Parameters
project_id
required
string
Request Body schema: application/json
role
string
Enum: "ADMIN" "MEMBER"

Role of the member.

user_ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "role": "ADMIN",
  • "user_ids": [
    ]
}

Reject an invitation to a project.

Reject an invitation to a project.

path Parameters
project_id
required
string

Responses

members

Get list of all active members from all projects u

Get list of all active members from all projects user belongs to.

Responses

Remove members from a project.

Remove members from a project.

path Parameters
project_id
required
string
Request Body schema: application/json
user_ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "user_ids": [
    ]
}

Get members of a project.

Get members of a project.

path Parameters
project_id
required
string
query Parameters
limit
integer [ 0 .. 100 ]
Default: 100
offset
integer
order_by
string
order_by_direction
string
Enum: "ASC" "DESC"

Responses

Add or update members for a project. When an email

Add or update members for a project. When an email address is not found invite it.

path Parameters
project_id
required
string
Request Body schema: application/json
emails
required
Array of strings <email> [ items <email > ]
role
string
Enum: "ADMIN" "MEMBER"

Role of the member.

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "role": "ADMIN"
}

Update existing members for a project.

Update existing members for a project.

path Parameters
project_id
required
string
Request Body schema: application/json
role
string
Enum: "ADMIN" "MEMBER"

Role of the member.

user_ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "role": "ADMIN",
  • "user_ids": [
    ]
}