Sessions

Download schema

A QPU session is a time interval where you can send and execute quantum jobs on a specific platform

List all sessions

GET

https://api.scaleway.com

/qaas/v1alpha1/sessions

Retrieve information about all QPU sessions.

List all sessions › query Parameters

project_id

string · required

List sessions belonging to this project ID. (UUID format)

platform_id

string

List sessions that have been created for this platform.

tags

string[]

List sessions with these tags.

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of sessions to return per page.

order_by

string · enum

Sort order of the returned sessions.

Enum values:

name_asc

name_desc

started_at_asc

started_at_desc

status_asc

status_desc

created_at_desc

created_at_asc

Default: name_asc

List all sessions › Responses

200

scaleway.qaas.v1alpha1.ListSessionsResponse

total_count

integer · uint64

Total number of sessions.

scaleway.qaas.v1alpha1.Session[]

List of sessions.

GET/qaas/v1alpha1/sessions

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/qaas/v1alpha1/sessions?project_id=6170692e-7363-616c-6577-61792e636f6d"

Example Responses

{
  "total_count": 0,
  "sessions": [
    {
      "id": "id",
      "name": "name",
      "platform_id": "platform_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",
      "terminated_at": "2022-03-22T12:34:56.123456Z",
      "max_idle_duration": "2.5s",
      "max_duration": "2.5s",
      "waiting_job_count": 0,
      "finished_job_count": 0,
      "status": "unknown_status",
      "project_id": "project_id",
      "tags": [
        "string"
      ],
      "deduplication_id": "deduplication_id",
      "origin_type": "unknown_origin_type",
      "origin_id": "origin_id",
      "progress_message": "progress_message",
      "booking_id": "booking_id",
      "model_id": "model_id",
      "parameters": "parameters"
    }
  ]
}

json

application/json

Create a session

POST

https://api.scaleway.com

/qaas/v1alpha1/sessions

Create a new QPU session for the specified platform. Once ready, jobs can be sent to this session.

Create a session › Request Body

project_id

string · required

ID of the Project in which the session was created. (UUID format)

platform_id

string · required

ID of the Platform for which the session was created.

name

string

Name of the session.

max_idle_duration

string

Maximum idle duration before the session ends. (in seconds)

max_duration

string

Maximum duration before the session ends. (in seconds)

tags

string[]

Tags of the session.

deduplication_id

string

Deduplication ID of the session.

object

A booking demand to schedule the session, only applicable if the platform is bookable.

model_id

string

Default computation model ID to be executed by job assigned to this session.

parameters

string

Optional platform configuration parameters applied to this session.

Create a session › Responses

200

scaleway.qaas.v1alpha1.Session

id

string

Unique ID of the session.

name

string

Name of the session.

platform_id

string

Platform ID for which the session has been created.

created_at

string · date-time

The time at which the session was created. (RFC 3339 format)

started_at

string · date-time

The time at which the session started. (RFC 3339 format)

updated_at

string · date-time

The time at which the session was updated. (RFC 3339 format)

terminated_at

string · date-time

The time at which the session was terminated. (RFC 3339 format)

max_idle_duration

string

Maximum idle time before the session ends. (in seconds)

max_duration

string

Maximum duration before the session ends. (in seconds)

waiting_job_count

integer · uint64

Number of waiting jobs linked to the session.

finished_job_count

integer · uint64

Number of finished jobs linked to the session.

status

string · enum

Status of the session.

Enum values:

unknown_status

running

stopped

starting

stopping

Default: unknown_status

project_id

string

Project ID in which the session has been created.

tags

string[]

Tags of the session.

deduplication_id

string

Deduplication ID of the session.

origin_type

string · enum

Resource type that creates the session.

Enum values:

unknown_origin_type

customer

process

Default: unknown_origin_type

origin_id

string

Unique ID of the session's origin resource (if exists).

progress_message

string

Any progress of the session.

booking_id

string

An optional booking unique ID of an attached booking.

model_id

string

Default computation model ID to be executed by job assigned to this session.

parameters

string

Platform configuration parameters applied to this session.

POST/qaas/v1alpha1/sessions

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform_id":"string","project_id":"6170692e-7363-616c-6577-61792e636f6d"}' \
  "https://api.scaleway.com/qaas/v1alpha1/sessions"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "platform_id": "platform_id",
  "name": "name",
  "max_idle_duration": "2.5s",
  "max_duration": "2.5s",
  "tags": [
    "string"
  ],
  "deduplication_id": "deduplication_id",
  "booking_demand": {
    "started_at": "2022-03-22T12:34:56.123456Z",
    "finished_at": "2022-03-22T12:34:56.123456Z",
    "description": "description",
    "time_zone": "time_zone"
  },
  "model_id": "model_id",
  "parameters": "parameters"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "platform_id": "platform_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",
  "terminated_at": "2022-03-22T12:34:56.123456Z",
  "max_idle_duration": "2.5s",
  "max_duration": "2.5s",
  "waiting_job_count": 0,
  "finished_job_count": 0,
  "status": "unknown_status",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "deduplication_id": "deduplication_id",
  "origin_type": "unknown_origin_type",
  "origin_id": "origin_id",
  "progress_message": "progress_message",
  "booking_id": "booking_id",
  "model_id": "model_id",
  "parameters": "parameters"
}

json

application/json

Get session information

GET

https://api.scaleway.com

/qaas/v1alpha1/sessions/{session_id}

Retrieve information about the provided session ID, such as name and status.

Get session information › path Parameters

session_id

string · required

Unique ID of the session.

Get session information › Responses

200

scaleway.qaas.v1alpha1.Session

id

string

Unique ID of the session.

name

string

Name of the session.

platform_id

string

Platform ID for which the session has been created.

created_at

string · date-time

The time at which the session was created. (RFC 3339 format)

started_at

string · date-time

The time at which the session started. (RFC 3339 format)

updated_at

string · date-time

The time at which the session was updated. (RFC 3339 format)

terminated_at

string · date-time

The time at which the session was terminated. (RFC 3339 format)

max_idle_duration

string

Maximum idle time before the session ends. (in seconds)

max_duration

string

Maximum duration before the session ends. (in seconds)

waiting_job_count

integer · uint64

Number of waiting jobs linked to the session.

finished_job_count

integer · uint64

Number of finished jobs linked to the session.

status

string · enum

Status of the session.

Enum values:

unknown_status

running

stopped

starting

stopping

Default: unknown_status

project_id

string

Project ID in which the session has been created.

tags

string[]

Tags of the session.

deduplication_id

string

Deduplication ID of the session.

origin_type

string · enum

Resource type that creates the session.

Enum values:

unknown_origin_type

customer

process

Default: unknown_origin_type

origin_id

string

Unique ID of the session's origin resource (if exists).

progress_message

string

Any progress of the session.

booking_id

string

An optional booking unique ID of an attached booking.

model_id

string

Default computation model ID to be executed by job assigned to this session.

parameters

string

Platform configuration parameters applied to this session.

GET/qaas/v1alpha1/sessions/{session_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/qaas/v1alpha1/sessions/{session_id}"

Example Responses

{
  "id": "id",
  "name": "name",
  "platform_id": "platform_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",
  "terminated_at": "2022-03-22T12:34:56.123456Z",
  "max_idle_duration": "2.5s",
  "max_duration": "2.5s",
  "waiting_job_count": 0,
  "finished_job_count": 0,
  "status": "unknown_status",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "deduplication_id": "deduplication_id",
  "origin_type": "unknown_origin_type",
  "origin_id": "origin_id",
  "progress_message": "progress_message",
  "booking_id": "booking_id",
  "model_id": "model_id",
  "parameters": "parameters"
}

json

application/json

Delete an existing session

DELETE

https://api.scaleway.com

/qaas/v1alpha1/sessions/{session_id}

Delete a session by its unique ID and delete all its attached jobs and bookings.

Delete an existing session › path Parameters

session_id

string · required

Unique ID of the session.

Delete an existing session › Responses

No data returned

Update session information

PATCH

https://api.scaleway.com

/qaas/v1alpha1/sessions/{session_id}

Update session information of the provided session ID.

Update session information › path Parameters

session_id

string · required

Unique ID of the session.

Update session information › Request Body

name

string

Name of the session.

max_idle_duration

string

Maximum idle duration before the session ends. (in seconds)

max_duration

string

Maximum time before the session ends. (in seconds)

tags

string[]

Tags of the session.

Update session information › Responses

200

scaleway.qaas.v1alpha1.Session

id

string

Unique ID of the session.

name

string

Name of the session.

platform_id

string

Platform ID for which the session has been created.

created_at

string · date-time

The time at which the session was created. (RFC 3339 format)

started_at

string · date-time

The time at which the session started. (RFC 3339 format)

updated_at

string · date-time

The time at which the session was updated. (RFC 3339 format)

terminated_at

string · date-time

The time at which the session was terminated. (RFC 3339 format)

max_idle_duration

string

Maximum idle time before the session ends. (in seconds)

max_duration

string

Maximum duration before the session ends. (in seconds)

waiting_job_count

integer · uint64

Number of waiting jobs linked to the session.

finished_job_count

integer · uint64

Number of finished jobs linked to the session.

status

string · enum

Status of the session.

Enum values:

unknown_status

running

stopped

starting

stopping

Default: unknown_status

project_id

string

Project ID in which the session has been created.

tags

string[]

Tags of the session.

deduplication_id

string

Deduplication ID of the session.

origin_type

string · enum

Resource type that creates the session.

Enum values:

unknown_origin_type

customer

process

Default: unknown_origin_type

origin_id

string

Unique ID of the session's origin resource (if exists).

progress_message

string

Any progress of the session.

booking_id

string

An optional booking unique ID of an attached booking.

model_id

string

Default computation model ID to be executed by job assigned to this session.

parameters

string

Platform configuration parameters applied to this session.

PATCH/qaas/v1alpha1/sessions/{session_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/qaas/v1alpha1/sessions/{session_id}"

Example Request Body

{
  "name": "name",
  "max_idle_duration": "2.5s",
  "max_duration": "2.5s",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "platform_id": "platform_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",
  "terminated_at": "2022-03-22T12:34:56.123456Z",
  "max_idle_duration": "2.5s",
  "max_duration": "2.5s",
  "waiting_job_count": 0,
  "finished_job_count": 0,
  "status": "unknown_status",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "deduplication_id": "deduplication_id",
  "origin_type": "unknown_origin_type",
  "origin_id": "origin_id",
  "progress_message": "progress_message",
  "booking_id": "booking_id",
  "model_id": "model_id",
  "parameters": "parameters"
}

json

application/json

Terminate an existing session

POST

https://api.scaleway.com

/qaas/v1alpha1/sessions/{session_id}/terminate

Terminate a session by its unique ID and cancel all its attached jobs and bookings.

Terminate an existing session › path Parameters

session_id

string · required

Unique ID of the session.

Terminate an existing session › Request Body

Terminate an existing session › Responses

200

scaleway.qaas.v1alpha1.Session

id

string

Unique ID of the session.

name

string

Name of the session.

platform_id

string

Platform ID for which the session has been created.

created_at

string · date-time

The time at which the session was created. (RFC 3339 format)

started_at

string · date-time

The time at which the session started. (RFC 3339 format)

updated_at

string · date-time

The time at which the session was updated. (RFC 3339 format)

terminated_at

string · date-time

The time at which the session was terminated. (RFC 3339 format)

max_idle_duration

string

Maximum idle time before the session ends. (in seconds)

max_duration

string

Maximum duration before the session ends. (in seconds)

waiting_job_count

integer · uint64

Number of waiting jobs linked to the session.

finished_job_count

integer · uint64

Number of finished jobs linked to the session.

status

string · enum

Status of the session.

Enum values:

unknown_status

running

stopped

starting

stopping

Default: unknown_status

project_id

string

Project ID in which the session has been created.

tags

string[]

Tags of the session.

deduplication_id

string

Deduplication ID of the session.

origin_type

string · enum

Resource type that creates the session.

Enum values:

unknown_origin_type

customer

process

Default: unknown_origin_type

origin_id

string

Unique ID of the session's origin resource (if exists).

progress_message

string

Any progress of the session.

booking_id

string

An optional booking unique ID of an attached booking.

model_id

string

Default computation model ID to be executed by job assigned to this session.

parameters

string

Platform configuration parameters applied to this session.

POST/qaas/v1alpha1/sessions/{session_id}/terminate

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/qaas/v1alpha1/sessions/{session_id}/terminate"

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "platform_id": "platform_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",
  "terminated_at": "2022-03-22T12:34:56.123456Z",
  "max_idle_duration": "2.5s",
  "max_duration": "2.5s",
  "waiting_job_count": 0,
  "finished_job_count": 0,
  "status": "unknown_status",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "deduplication_id": "deduplication_id",
  "origin_type": "unknown_origin_type",
  "origin_id": "origin_id",
  "progress_message": "progress_message",
  "booking_id": "booking_id",
  "model_id": "model_id",
  "parameters": "parameters"
}

json

application/json

Platforms Jobs

List all sessions

GET

https://api.scaleway.com

/qaas/v1alpha1/sessions

Retrieve information about all QPU sessions.

List all sessions › query Parameters

project_id

string · required

List sessions belonging to this project ID. (UUID format)

platform_id

string

List sessions that have been created for this platform.

tags

string[]

List sessions with these tags.

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of sessions to return per page.

order_by

string · enum

Sort order of the returned sessions.

Enum values:

name_asc

name_desc

started_at_asc

started_at_desc

status_asc

status_desc

created_at_desc

created_at_asc

Default: name_asc

List all sessions › Responses

200

scaleway.qaas.v1alpha1.ListSessionsResponse

total_count

integer · uint64

Total number of sessions.

scaleway.qaas.v1alpha1.Session[]

List of sessions.

Create a session

POST

https://api.scaleway.com

/qaas/v1alpha1/sessions

Create a new QPU session for the specified platform. Once ready, jobs can be sent to this session.

Create a session › Request Body

project_id

string · required

ID of the Project in which the session was created. (UUID format)

platform_id

string · required

ID of the Platform for which the session was created.

name

string

Name of the session.

max_idle_duration

string

Maximum idle duration before the session ends. (in seconds)

max_duration

string

Maximum duration before the session ends. (in seconds)

tags

string[]

Tags of the session.

deduplication_id

string

Deduplication ID of the session.

object

A booking demand to schedule the session, only applicable if the platform is bookable.

model_id

string

Default computation model ID to be executed by job assigned to this session.

parameters

string

Optional platform configuration parameters applied to this session.

Create a session › Responses

200

scaleway.qaas.v1alpha1.Session

id

string

Unique ID of the session.

name

string

Name of the session.

platform_id

string

Platform ID for which the session has been created.

created_at

string · date-time

The time at which the session was created. (RFC 3339 format)

started_at

string · date-time

The time at which the session started. (RFC 3339 format)

updated_at

string · date-time

The time at which the session was updated. (RFC 3339 format)

terminated_at

string · date-time

The time at which the session was terminated. (RFC 3339 format)

max_idle_duration

string

Maximum idle time before the session ends. (in seconds)

max_duration

string

Maximum duration before the session ends. (in seconds)

waiting_job_count

integer · uint64

Number of waiting jobs linked to the session.

finished_job_count

integer · uint64

Number of finished jobs linked to the session.

status

string · enum

Status of the session.

Enum values:

unknown_status

running

stopped

starting

stopping

Default: unknown_status

project_id

string

Project ID in which the session has been created.

tags

string[]

Tags of the session.

deduplication_id

string

Deduplication ID of the session.

origin_type

string · enum

Resource type that creates the session.

Enum values:

unknown_origin_type

customer

process

Default: unknown_origin_type

origin_id

string

Unique ID of the session's origin resource (if exists).

progress_message

string

Any progress of the session.

booking_id

string

An optional booking unique ID of an attached booking.

model_id

string

Default computation model ID to be executed by job assigned to this session.

parameters

string

Platform configuration parameters applied to this session.

Get session information

GET

https://api.scaleway.com

/qaas/v1alpha1/sessions/{session_id}

Retrieve information about the provided session ID, such as name and status.

Get session information › path Parameters

session_id

string · required

Unique ID of the session.

Get session information › Responses

200

scaleway.qaas.v1alpha1.Session

id

string

Unique ID of the session.

name

string

Name of the session.

platform_id

string

Platform ID for which the session has been created.

created_at

string · date-time

The time at which the session was created. (RFC 3339 format)

started_at

string · date-time

The time at which the session started. (RFC 3339 format)

updated_at

string · date-time

The time at which the session was updated. (RFC 3339 format)

terminated_at

string · date-time

The time at which the session was terminated. (RFC 3339 format)

max_idle_duration

string

Maximum idle time before the session ends. (in seconds)

max_duration

string

Maximum duration before the session ends. (in seconds)

waiting_job_count

integer · uint64

Number of waiting jobs linked to the session.

finished_job_count

integer · uint64

Number of finished jobs linked to the session.

status

string · enum

Status of the session.

Enum values:

unknown_status

running

stopped

starting

stopping

Default: unknown_status

project_id

string

Project ID in which the session has been created.

tags

string[]

Tags of the session.

deduplication_id

string

Deduplication ID of the session.

origin_type

string · enum

Resource type that creates the session.

Enum values:

unknown_origin_type

customer

process

Default: unknown_origin_type

origin_id

string

Unique ID of the session's origin resource (if exists).

progress_message

string

Any progress of the session.

booking_id

string

An optional booking unique ID of an attached booking.

model_id

string

Default computation model ID to be executed by job assigned to this session.

parameters

string

Platform configuration parameters applied to this session.

Delete an existing session

DELETE

https://api.scaleway.com

/qaas/v1alpha1/sessions/{session_id}

Delete a session by its unique ID and delete all its attached jobs and bookings.

Delete an existing session › path Parameters

session_id

string · required

Unique ID of the session.

Delete an existing session › Responses

No data returned

Update session information

PATCH

https://api.scaleway.com

/qaas/v1alpha1/sessions/{session_id}

Update session information of the provided session ID.

Update session information › path Parameters

session_id

string · required

Unique ID of the session.

Update session information › Request Body

name

string

Name of the session.

max_idle_duration

string

Maximum idle duration before the session ends. (in seconds)

max_duration

string

Maximum time before the session ends. (in seconds)

tags

string[]

Tags of the session.

Update session information › Responses

200

scaleway.qaas.v1alpha1.Session

id

string

Unique ID of the session.

name

string

Name of the session.

platform_id

string

Platform ID for which the session has been created.

created_at

string · date-time

The time at which the session was created. (RFC 3339 format)

started_at

string · date-time

The time at which the session started. (RFC 3339 format)

updated_at

string · date-time

The time at which the session was updated. (RFC 3339 format)

terminated_at

string · date-time

The time at which the session was terminated. (RFC 3339 format)

max_idle_duration

string

Maximum idle time before the session ends. (in seconds)

max_duration

string

Maximum duration before the session ends. (in seconds)

waiting_job_count

integer · uint64

Number of waiting jobs linked to the session.

finished_job_count

integer · uint64

Number of finished jobs linked to the session.

status

string · enum

Status of the session.

Enum values:

unknown_status

running

stopped

starting

stopping

Default: unknown_status

project_id

string

Project ID in which the session has been created.

tags

string[]

Tags of the session.

deduplication_id

string

Deduplication ID of the session.

origin_type

string · enum

Resource type that creates the session.

Enum values:

unknown_origin_type

customer

process

Default: unknown_origin_type

origin_id

string

Unique ID of the session's origin resource (if exists).

progress_message

string

Any progress of the session.

booking_id

string

An optional booking unique ID of an attached booking.

model_id

string

Default computation model ID to be executed by job assigned to this session.

parameters

string

Platform configuration parameters applied to this session.

Terminate an existing session

POST

https://api.scaleway.com

/qaas/v1alpha1/sessions/{session_id}/terminate

Terminate a session by its unique ID and cancel all its attached jobs and bookings.

Terminate an existing session › path Parameters

session_id

string · required

Unique ID of the session.

Terminate an existing session › Request Body

Terminate an existing session › Responses

200

scaleway.qaas.v1alpha1.Session

id

string

Unique ID of the session.

name

string

Name of the session.

platform_id

string

Platform ID for which the session has been created.

created_at

string · date-time

The time at which the session was created. (RFC 3339 format)

started_at

string · date-time

The time at which the session started. (RFC 3339 format)

updated_at

string · date-time

The time at which the session was updated. (RFC 3339 format)

terminated_at

string · date-time

The time at which the session was terminated. (RFC 3339 format)

max_idle_duration

string

Maximum idle time before the session ends. (in seconds)

max_duration

string

Maximum duration before the session ends. (in seconds)

waiting_job_count

integer · uint64

Number of waiting jobs linked to the session.

finished_job_count

integer · uint64

Number of finished jobs linked to the session.

status

string · enum

Status of the session.

Enum values:

unknown_status

running

stopped

starting

stopping

Default: unknown_status

project_id

string

Project ID in which the session has been created.

tags

string[]

Tags of the session.

deduplication_id

string

Deduplication ID of the session.

origin_type

string · enum

Resource type that creates the session.

Enum values:

unknown_origin_type

customer

process

Default: unknown_origin_type

origin_id

string

Unique ID of the session's origin resource (if exists).

progress_message

string

Any progress of the session.

booking_id

string

An optional booking unique ID of an attached booking.

model_id

string

Default computation model ID to be executed by job assigned to this session.

parameters

string

Platform configuration parameters applied to this session.