Jobs

Download schema

A job is your quantum computational model to be is executed on a QPU session

List all jobs within a project or session

GET

https://api.scaleway.com

/qaas/v1alpha1/jobs

Retrieve information about all jobs within a given session.

List all jobs within a project or session › query Parameters

tags

string[]

List jobs with these tags.

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of jobs to return per page.

order_by

string · enum

Sort order of the returned jobs.

Enum values:

created_at_desc

created_at_asc

status_asc

status_desc

platform_name_asc

platform_name_desc

name_asc

name_desc

Default: created_at_desc

List all jobs within a project or session › Responses

200

scaleway.qaas.v1alpha1.ListJobsResponse

total_count

integer · uint64

Total number of jobs.

scaleway.qaas.v1alpha1.Job[]

List of jobs.

Create a job

POST

https://api.scaleway.com

/qaas/v1alpha1/jobs

Create a job to be executed inside a QPU session.

Create a job › Request Body

name

string · required

Name of the job.

session_id

string · required

Session in which the job is executed.

object · required

Quantum circuit that should be executed.

tags

string[]

Tags of the job.

max_duration

string

Maximum duration of the job. (in seconds)

model_id

string

Computation model ID to be executed by the job.

parameters

string

Execution parameters for this job.

Create a job › Responses

200

scaleway.qaas.v1alpha1.Job

id

string

Unique ID of the job.

name

string

Job name.

tags

string[]

Tags of the job.

session_id

string

Session ID in which the job is executed.

created_at

string · date-time

Time at which the job was created. (RFC 3339 format)

started_at

string · date-time

Time at which the job was started. (RFC 3339 format)

updated_at

string · date-time

Time at which the job was updated. (RFC 3339 format)

status

string · enum

Job status.

Enum values:

unknown_status

waiting

error

running

completed

cancelling

cancelled

Default: unknown_status

progress_message

string

Last progress message, if the job has started.

job_duration

string

Duration of the job, if the job is finished. (in seconds)

result_distribution

string

Result of the job, if the job is finished.

model_id

string

Computation model ID executed by the job.

parameters

string

Execution parameters for this job.

POST/qaas/v1alpha1/jobs

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "circuit": {
        "perceval_circuit": "string",
        "qiskit_circuit": "string"
    },
    "name": "string",
    "session_id": "string"
  }' \
  "https://api.scaleway.com/qaas/v1alpha1/jobs"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ],
  "session_id": "session_id",
  "circuit": {
    "perceval_circuit": "perceval_circuit",
    "qiskit_circuit": "qiskit_circuit"
  },
  "max_duration": "2.5s",
  "model_id": "model_id",
  "parameters": "parameters"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "tags": [
    "string"
  ],
  "session_id": "session_id",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "started_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "progress_message": "progress_message",
  "job_duration": "2.5s",
  "result_distribution": "result_distribution",
  "model_id": "model_id",
  "parameters": "parameters"
}

json

application/json

Get job information

GET

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}

Retrieve information about the provided job ID, mainly used to get the current status.

Get job information › path Parameters

job_id

string · required

Unique ID of the job you want to get.

Get job information › Responses

200

scaleway.qaas.v1alpha1.Job

id

string

Unique ID of the job.

name

string

Job name.

tags

string[]

Tags of the job.

session_id

string

Session ID in which the job is executed.

created_at

string · date-time

Time at which the job was created. (RFC 3339 format)

started_at

string · date-time

Time at which the job was started. (RFC 3339 format)

updated_at

string · date-time

Time at which the job was updated. (RFC 3339 format)

status

string · enum

Job status.

Enum values:

unknown_status

waiting

error

running

completed

cancelling

cancelled

Default: unknown_status

progress_message

string

Last progress message, if the job has started.

job_duration

string

Duration of the job, if the job is finished. (in seconds)

result_distribution

string

Result of the job, if the job is finished.

model_id

string

Computation model ID executed by the job.

parameters

string

Execution parameters for this job.

Delete a job

DELETE

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}

Delete the job corresponding to the provided job ID.

Delete a job › path Parameters

job_id

string · required

Unique ID of the job.

Delete a job › Responses

No data returned

Update job information

PATCH

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}

Update job information about the provided job ID.

Update job information › path Parameters

job_id

string · required

Unique ID of the job.

Update job information › Request Body

name

string

Name of the job.

tags

string[]

Tags of the job.

Update job information › Responses

200

scaleway.qaas.v1alpha1.Job

id

string

Unique ID of the job.

name

string

Job name.

tags

string[]

Tags of the job.

session_id

string

Session ID in which the job is executed.

created_at

string · date-time

Time at which the job was created. (RFC 3339 format)

started_at

string · date-time

Time at which the job was started. (RFC 3339 format)

updated_at

string · date-time

Time at which the job was updated. (RFC 3339 format)

status

string · enum

Job status.

Enum values:

unknown_status

waiting

error

running

completed

cancelling

cancelled

Default: unknown_status

progress_message

string

Last progress message, if the job has started.

job_duration

string

Duration of the job, if the job is finished. (in seconds)

result_distribution

string

Result of the job, if the job is finished.

model_id

string

Computation model ID executed by the job.

parameters

string

Execution parameters for this job.

Cancel a job

POST

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}/cancel

Cancel the job corresponding to the provided job ID.

Cancel a job › path Parameters

job_id

string · required

Unique ID of the job.

Cancel a job › Request Body

Cancel a job › Responses

200

scaleway.qaas.v1alpha1.Job

id

string

Unique ID of the job.

name

string

Job name.

tags

string[]

Tags of the job.

session_id

string

Session ID in which the job is executed.

created_at

string · date-time

Time at which the job was created. (RFC 3339 format)

started_at

string · date-time

Time at which the job was started. (RFC 3339 format)

updated_at

string · date-time

Time at which the job was updated. (RFC 3339 format)

status

string · enum

Job status.

Enum values:

unknown_status

waiting

error

running

completed

cancelling

cancelled

Default: unknown_status

progress_message

string

Last progress message, if the job has started.

job_duration

string

Duration of the job, if the job is finished. (in seconds)

result_distribution

string

Result of the job, if the job is finished.

model_id

string

Computation model ID executed by the job.

parameters

string

Execution parameters for this job.

Get a job circuit

GET

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}/circuit

Retrieve the circuit of the provided job ID.

Get a job circuit › path Parameters

job_id

string · required

Unique ID of the job.

Get a job circuit › Responses

200

scaleway.qaas.v1alpha1.JobCircuit

perceval_circuit

string

Circuit generated by Perceval that should be executed.

qiskit_circuit

string

Circuit generated by Qiskit that should be executed.

List all results of a job

GET

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}/results

Retrieve all intermediate and final results of a job.

List all results of a job › path Parameters

job_id

string · required

ID of the job.

List all results of a job › query Parameters

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of results to return per page.

order_by

string · enum

Sort order of the returned results.

Enum values:

created_at_desc

created_at_asc

Default: created_at_desc

List all results of a job › Responses

200

scaleway.qaas.v1alpha1.ListJobResultsResponse

total_count

integer · uint64

Total number of results.

scaleway.qaas.v1alpha1.JobResult[]

List of results.

Sessions Applications

Quantum as a Service API

Jobs

Download schema

A job is your quantum computational model to be is executed on a QPU session

List all jobs within a project or session

GET

https://api.scaleway.com

/qaas/v1alpha1/jobs

Retrieve information about all jobs within a given session.

List all jobs within a project or session › query Parameters

tags

string[]

List jobs with these tags.

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of jobs to return per page.

order_by

string · enum

Sort order of the returned jobs.

Enum values:

created_at_desc

created_at_asc

status_asc

status_desc

platform_name_asc

platform_name_desc

name_asc

name_desc

Default: created_at_desc

List all jobs within a project or session › Responses

200

scaleway.qaas.v1alpha1.ListJobsResponse

total_count

integer · uint64

Total number of jobs.

scaleway.qaas.v1alpha1.Job[]

List of jobs.

Create a job

POST

https://api.scaleway.com

/qaas/v1alpha1/jobs

Create a job to be executed inside a QPU session.

Create a job › Request Body

name

string · required

Name of the job.

session_id

string · required

Session in which the job is executed.

object · required

Quantum circuit that should be executed.

tags

string[]

Tags of the job.

max_duration

string

Maximum duration of the job. (in seconds)

model_id

string

Computation model ID to be executed by the job.

parameters

string

Execution parameters for this job.

Create a job › Responses

200

scaleway.qaas.v1alpha1.Job

id

string

Unique ID of the job.

name

string

Job name.

tags

string[]

Tags of the job.

session_id

string

Session ID in which the job is executed.

created_at

string · date-time

Time at which the job was created. (RFC 3339 format)

started_at

string · date-time

Time at which the job was started. (RFC 3339 format)

updated_at

string · date-time

Time at which the job was updated. (RFC 3339 format)

status

string · enum

Job status.

Enum values:

unknown_status

waiting

error

running

completed

cancelling

cancelled

Default: unknown_status

progress_message

string

Last progress message, if the job has started.

job_duration

string

Duration of the job, if the job is finished. (in seconds)

result_distribution

string

Result of the job, if the job is finished.

model_id

string

Computation model ID executed by the job.

parameters

string

Execution parameters for this job.

POST/qaas/v1alpha1/jobs

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "circuit": {
        "perceval_circuit": "string",
        "qiskit_circuit": "string"
    },
    "name": "string",
    "session_id": "string"
  }' \
  "https://api.scaleway.com/qaas/v1alpha1/jobs"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ],
  "session_id": "session_id",
  "circuit": {
    "perceval_circuit": "perceval_circuit",
    "qiskit_circuit": "qiskit_circuit"
  },
  "max_duration": "2.5s",
  "model_id": "model_id",
  "parameters": "parameters"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "tags": [
    "string"
  ],
  "session_id": "session_id",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "started_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "progress_message": "progress_message",
  "job_duration": "2.5s",
  "result_distribution": "result_distribution",
  "model_id": "model_id",
  "parameters": "parameters"
}

json

application/json

Get job information

GET

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}

Retrieve information about the provided job ID, mainly used to get the current status.

Get job information › path Parameters

job_id

string · required

Unique ID of the job you want to get.

Get job information › Responses

200

scaleway.qaas.v1alpha1.Job

id

string

Unique ID of the job.

name

string

Job name.

tags

string[]

Tags of the job.

session_id

string

Session ID in which the job is executed.

created_at

string · date-time

Time at which the job was created. (RFC 3339 format)

started_at

string · date-time

Time at which the job was started. (RFC 3339 format)

updated_at

string · date-time

Time at which the job was updated. (RFC 3339 format)

status

string · enum

Job status.

Enum values:

unknown_status

waiting

error

running

completed

cancelling

cancelled

Default: unknown_status

progress_message

string

Last progress message, if the job has started.

job_duration

string

Duration of the job, if the job is finished. (in seconds)

result_distribution

string

Result of the job, if the job is finished.

model_id

string

Computation model ID executed by the job.

parameters

string

Execution parameters for this job.

Delete a job

DELETE

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}

Delete the job corresponding to the provided job ID.

Delete a job › path Parameters

job_id

string · required

Unique ID of the job.

Delete a job › Responses

No data returned

Update job information

PATCH

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}

Update job information about the provided job ID.

Update job information › path Parameters

job_id

string · required

Unique ID of the job.

Update job information › Request Body

name

string

Name of the job.

tags

string[]

Tags of the job.

Update job information › Responses

200

scaleway.qaas.v1alpha1.Job

id

string

Unique ID of the job.

name

string

Job name.

tags

string[]

Tags of the job.

session_id

string

Session ID in which the job is executed.

created_at

string · date-time

Time at which the job was created. (RFC 3339 format)

started_at

string · date-time

Time at which the job was started. (RFC 3339 format)

updated_at

string · date-time

Time at which the job was updated. (RFC 3339 format)

status

string · enum

Job status.

Enum values:

unknown_status

waiting

error

running

completed

cancelling

cancelled

Default: unknown_status

progress_message

string

Last progress message, if the job has started.

job_duration

string

Duration of the job, if the job is finished. (in seconds)

result_distribution

string

Result of the job, if the job is finished.

model_id

string

Computation model ID executed by the job.

parameters

string

Execution parameters for this job.

Cancel a job

POST

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}/cancel

Cancel the job corresponding to the provided job ID.

Cancel a job › path Parameters

job_id

string · required

Unique ID of the job.

Cancel a job › Request Body

Cancel a job › Responses

200

scaleway.qaas.v1alpha1.Job

id

string

Unique ID of the job.

name

string

Job name.

tags

string[]

Tags of the job.

session_id

string

Session ID in which the job is executed.

created_at

string · date-time

Time at which the job was created. (RFC 3339 format)

started_at

string · date-time

Time at which the job was started. (RFC 3339 format)

updated_at

string · date-time

Time at which the job was updated. (RFC 3339 format)

status

string · enum

Job status.

Enum values:

unknown_status

waiting

error

running

completed

cancelling

cancelled

Default: unknown_status

progress_message

string

Last progress message, if the job has started.

job_duration

string

Duration of the job, if the job is finished. (in seconds)

result_distribution

string

Result of the job, if the job is finished.

model_id

string

Computation model ID executed by the job.

parameters

string

Execution parameters for this job.

Get a job circuit

GET

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}/circuit

Retrieve the circuit of the provided job ID.

Get a job circuit › path Parameters

job_id

string · required

Unique ID of the job.

Get a job circuit › Responses

200

scaleway.qaas.v1alpha1.JobCircuit

perceval_circuit

string

Circuit generated by Perceval that should be executed.

qiskit_circuit

string

Circuit generated by Qiskit that should be executed.

List all results of a job

GET

https://api.scaleway.com

/qaas/v1alpha1/jobs/{job_id}/results

Retrieve all intermediate and final results of a job.

List all results of a job › path Parameters

job_id

string · required

ID of the job.

List all results of a job › query Parameters

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of results to return per page.

order_by

string · enum

Sort order of the returned results.

Enum values:

created_at_desc

created_at_asc

Default: created_at_desc

List all results of a job › Responses

200

scaleway.qaas.v1alpha1.ListJobResultsResponse

total_count

integer · uint64

Total number of results.

scaleway.qaas.v1alpha1.JobResult[]

List of results.

Sessions Applications