v0.0.1

QDash API

QDash API

API for QDash

Contact

oqtopus-team@googlegroups.com

License

Apache 2.0

---

calibration

Operations

GET/api/calibration/noteGET/api/calibration/cron-schedulePOST/api/calibration/cron-schedulePOST/api/calibrationGET/api/calibration/schedulePOST/api/calibration/scheduleDELETE/api/calibration/schedule/{flow_run_id}

---

Fetches all the cron schedules.

GET

/api/calibration/note

Get the calibration note.

Responses

Successful Response

Content-Type

application/json

{

"username": "string",

"execution_id": "string",

"task_id": "string",

"note": {

"additionalProperties": "string"

},

"timestamp": "string"

}

GET

/api/calibration/note

Samples

cURL

curl -X GET \
'http://localhost/api/calibration/note' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/calibration/note', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/calibration/note';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/calibration/note'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetches all the cron schedules.

GET

/api/calibration/note

Get the calibration note.

Responses

Successful Response

Content-Type

application/json

{

"username": "string",

"execution_id": "string",

"task_id": "string",

"note": {

"additionalProperties": "string"

},

"timestamp": "string"

}

GET

/api/calibration/note

Samples

cURL

curl -X GET \
'http://localhost/api/calibration/note' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/calibration/note', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/calibration/note';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/calibration/note'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Schedules a calibration with cron.

POST

/api/calibration/cron-schedule

Schedule a calibration.

Request Body

{

"scheduler_name": "string",

"menu_name": "string",

"cron": "string",

"active": true

}

Responses

Successful Response

Content-Type

application/json

{

"scheduler_name": "string",

"menu_name": "string",

"cron": "string",

"active": true

}

POST

/api/calibration/cron-schedule

Samples

cURL

curl -X POST \
'http://localhost/api/calibration/cron-schedule' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/calibration/cron-schedule', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/calibration/cron-schedule';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/calibration/cron-schedule'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

Executes a calibration by creating a flow run from a deployment.

POST

/api/calibration

Create a flow run from a deployment.

Request Body

Use example

{

"name": "string",

"chip_id": "string",

"username": "string",

"description": "string",

"backend": "string",

"schedule": "string",

"notify_bool": true,

"tasks": "string",

"task_details": "string",

"tags": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"flow_run_url": "string",

"qdash_ui_url": "string"

}

POST

/api/calibration

Samples

cURL

curl -X POST \
'http://localhost/api/calibration' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/calibration', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/calibration';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/calibration'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

Fetches all the calibration schedules.

GET

/api/calibration/schedule

Fetch all the calibration schedules.

Responses

Successful Response

Content-Type

application/json

Use example

[

{

"menu_name": "string",

"menu": {

"name": "string",

"chip_id": "string",

"username": "string",

"description": "string",

"backend": "string",

"schedule": "string",

"notify_bool": true,

"tasks": "string",

"task_details": "string",

"tags": "string"

},

"description": "string",

"note": "string",

"timezone": "string",

"scheduled_time": "string",

"flow_run_id": "string"

}

]

GET

/api/calibration/schedule

Samples

cURL

curl -X GET \
'http://localhost/api/calibration/schedule' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/calibration/schedule', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/calibration/schedule';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/calibration/schedule'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Schedules a calibration.

POST

/api/calibration/schedule

Schedule a calibration.

Request Body

{

"menu_name": "string",

"scheduled": "string"

}

Responses

Successful Response

Content-Type

application/json

Use example

{

"menu_name": "string",

"menu": {

"name": "string",

"chip_id": "string",

"username": "string",

"description": "string",

"backend": "string",

"schedule": "string",

"notify_bool": true,

"tasks": "string",

"task_details": "string",

"tags": "string"

},

"description": "string",

"note": "string",

"timezone": "string",

"scheduled_time": "string",

"flow_run_id": "string"

}

POST

/api/calibration/schedule

Samples

cURL

curl -X POST \
'http://localhost/api/calibration/schedule' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/calibration/schedule', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/calibration/schedule';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/calibration/schedule'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

Deletes a calibration schedule.

DELETE

/api/calibration/schedule/{flow_run_id}

Delete a calibration schedule.

Parameters

Path Parameters

flow_run_id*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

[

]

DELETE

/api/calibration/schedule/{flow_run_id}

Samples

cURL

curl -X DELETE \
'http://localhost/api/calibration/schedule/{flow_run_id}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/calibration/schedule/{flow_run_id}', {method:'DELETE',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/calibration/schedule/{flow_run_id}';
$method = 'DELETE';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/calibration/schedule/{flow_run_id}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.delete(url, headers=headers)
print(response.json())

---

menu

Operations

GET/api/menuPOST/api/menuGET/api/menu/presetGET/api/menu/{name}PUT/api/menu/{name}DELETE/api/menu/{name}

---

Retrieve a list of menu items.

GET

/api/menu

Retrieve a list of menu items.

Returns

ListMenuResponse: A response containing the list of menu items.

Responses

Successful Response

Content-Type

application/json

{

"menus": [

{

"name": "string",

"chip_id": "string",

"username": "string",

"description": "string",

"backend": "string",

"schedule": "string",

"notify_bool": true,

"tasks": "string",

"task_details": "string",

"tags": "string"

}

]

}

GET

/api/menu

Samples

cURL

curl -X GET \
'http://localhost/api/menu' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/menu', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/menu';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/menu'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Create a new menu item.

POST

/api/menu

Create a new menu item.

Args:

request (CreateMenuRequest): The request object containing the menu item details.
current_user (User): The current authenticated user.

Returns:

CreateMenuResponse: The response object containing the name of the created menu item.

Request Body

Use example

{

"name": "string",

"chip_id": "string",

"username": "string",

"description": "string",

"backend": "string",

"schedule": "string",

"notify_bool": true,

"tasks": "string",

"task_details": "string",

"tags": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"name": "string"

}

POST

/api/menu

Samples

cURL

curl -X POST \
'http://localhost/api/menu' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/menu', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/menu';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/menu'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

Retrieve a list of preset menu items.

GET

/api/menu/preset

Retrieve a list of preset menu items.

Returns

ListMenuResponse: A response containing the list of preset menu items.

Responses

Successful Response

Content-Type

application/json

{

"menus": [

{

"name": "string",

"chip_id": "string",

"username": "string",

"description": "string",

"backend": "string",

"schedule": "string",

"notify_bool": true,

"tasks": "string",

"task_details": "string",

"tags": "string"

}

]

}

GET

/api/menu/preset

Samples

cURL

curl -X GET \
'http://localhost/api/menu/preset' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/menu/preset', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/menu/preset';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/menu/preset'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Retrieve a menu by its name.

GET

/api/menu/{name}

Retrieve a menu by its name.

Args:

name (str): The name of the menu.
current_user (User): The current authenticated user.

Returns:

GetMenuResponse: The response containing the menu details.

Raises:

InternalServerError: If there is an error retrieving the menu.
NotFoundErrorResponse: If the menu is not found.

Parameters

Path Parameters

name*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"name": "string",

"chip_id": "string",

"username": "string",

"description": "string",

"backend": "string",

"schedule": "string",

"notify_bool": true,

"tasks": "string",

"task_details": "string",

"tags": "string"

}

GET

/api/menu/{name}

Samples

cURL

curl -X GET \
'http://localhost/api/menu/{name}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/menu/{name}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/menu/{name}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/menu/{name}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Update a menu with the given name.

PUT

/api/menu/{name}

Update a menu with the given name.

Args:

name (str): The name of the menu to update.
req (UpdateMenuRequest): The request object containing the updated menu data.
current_user (User): The current authenticated user.

Returns:

Union[UpdateMenuResponse, NotFoundErrorResponse]: The response object indicating the success of the update or an error if the menu is not found.

Parameters

Path Parameters

name*

Typestring

Required

Request Body

{

"name": "string",

"chip_id": "string",

"username": "string",

"description": "string",

"backend": "string",

"schedule": "string",

"notify_bool": true,

"tasks": "string",

"task_details": "string",

"tags": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"name": "string"

}

PUT

/api/menu/{name}

Samples

cURL

curl -X PUT \
'http://localhost/api/menu/{name}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/menu/{name}', {method:'PUT',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/menu/{name}';
$method = 'PUT';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/menu/{name}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.put(url, headers=headers)
print(response.json())

---

Delete a menu by its name.

DELETE

/api/menu/{name}

Delete a menu by its name.

Args:

name (str): The name of the menu to be deleted.
current_user (User): The current authenticated user.

Returns:

DeleteMenuResponse | NotFoundErrorResponse: The response indicating the success or failure of the deletion.

Parameters

Path Parameters

name*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"name": "string"

}

DELETE

/api/menu/{name}

Samples

cURL

curl -X DELETE \
'http://localhost/api/menu/{name}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/menu/{name}', {method:'DELETE',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/menu/{name}';
$method = 'DELETE';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/menu/{name}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.delete(url, headers=headers)
print(response.json())

---

settings

Operations

GET/api/settings

---

Get settings

GET

/api/settings

Get settings from the server

Responses

Successful Response

Content-Type

application/json

{

"env": "string",

"client_url": "string",

"prefect_api_url": "string",

"slack_bot_token": "string",

"slack_channel_id": "string",

"postgres_data_path": "string",

"mongo_data_path": "string",

"calib_data_path": "string",

"qpu_data_path": "string",

"backend": "string",

"mongo_port": 0,

"mongo_express_port": 0,

"postgres_port": 0,

"prefect_port": 0,

"api_port": 0,

"ui_port": 0

}

GET

/api/settings

Samples

cURL

curl -X GET \
'http://localhost/api/settings' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/settings', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/settings';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/settings'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

execution

Operations

GET/api/executions/figureGET/api/executions/lock_status

---

Fetches a calibration figure by its path

GET

/api/executions/figure

Fetch a calibration figure by its path.

Parameters

Query Parameters

path*

Typestring

Required

Responses

Successful Response

GET

/api/executions/figure

Samples

cURL

curl -X GET \
'http://localhost/api/executions/figure' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/executions/figure', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/executions/figure';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/executions/figure'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetches the status of a calibration.

GET

/api/executions/lock_status

Fetch the status of the execution lock.

Responses

Successful Response

Content-Type

application/json

{

"lock": true

}

GET

/api/executions/lock_status

Samples

cURL

curl -X GET \
'http://localhost/api/executions/lock_status' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/executions/lock_status', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/executions/lock_status';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/executions/lock_status'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

chip

Operations

GET/api/chipGET/api/chip/{chip_id}/datesGET/api/chip/{chip_id}GET/api/chip/{chip_id}/executionGET/api/chip/{chip_id}/execution/{execution_id}GET/api/chip/{chip_id}/mux/{mux_id}GET/api/chip/{chip_id}/muxGET/api/chip/{chip_id}/task/qubit/{task_name}/history/{recorded_date}GET/api/chip/{chip_id}/task/qubit/{task_name}GET/api/chip/{chip_id}/task/coupling/{task_name}/history/{recorded_date}GET/api/chip/{chip_id}/task/coupling/{task_name}GET/api/chip/{chip_id}/parameter/{parameter}/qid/{qid}GET/api/chip/{chip_id}/parameter/{parameter}

---

Fetch all chips

GET

/api/chip

Fetch all chips.

Parameters

current_user : User
Current authenticated user

Returns

list[ChipResponse]
List of available chips

Authorizations

APIKeyHeader

Type: API Key (header: X-Username)

Responses

Successful Response

Content-Type

application/json

[

{

"chip_id": "string",

"size": 0,

"qubits": {

"additionalProperties": "string"

},

"couplings": {

"additionalProperties": "string"

},

"installed_at": "string"

}

]

GET

/api/chip

Samples

cURL

curl -X GET \
'http://localhost/api/chip' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch available dates for a chip

GET

/api/chip/{chip_id}/dates

Fetch available dates for a chip from execution counter.

Parameters

chip_id : str
ID of the chip
current_user : User
Current authenticated user

Returns

list[str]
List of available dates in ISO format

Parameters

Path Parameters

chip_id*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"data": [

"string"

]

}

GET

/api/chip/{chip_id}/dates

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/dates' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/dates', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/dates';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/dates'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch a chip

GET

/api/chip/{chip_id}

Fetch a chip by its ID.

Parameters

chip_id : str
ID of the chip to fetch
current_user : User
Current authenticated user

Returns

ChipResponse
Chip information

Parameters

Path Parameters

chip_id*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"chip_id": "string",

"size": 0,

"qubits": {

"additionalProperties": "string"

},

"couplings": {

"additionalProperties": "string"

},

"installed_at": "string"

}

GET

/api/chip/{chip_id}

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch executions

GET

/api/chip/{chip_id}/execution

Fetch all executions for a given chip.

Parameters

chip_id : str
ID of the chip to fetch executions for
current_user : str
Current user ID from authentication

Returns

list[ExecutionResponseSummary]
List of executions for the chip

Parameters

Path Parameters

chip_id*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

[

{

"name": "string",

"execution_id": "string",

"status": "string",

"start_at": "string",

"end_at": "string",

"elapsed_time": "string",

"tags": [

"string"

],

"note": {

"additionalProperties": "string"

}

}

]

GET

/api/chip/{chip_id}/execution

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/execution' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/execution', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/execution';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/execution'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch an execution by its ID

GET

/api/chip/{chip_id}/execution/{execution_id}

Return the execution detail by its ID.

Parameters

chip_id : str
ID of the chip
execution_id : str
ID of the execution to fetch
current_user : User
Current authenticated user

Returns

ExecutionResponseDetail
Detailed execution information

Parameters

Path Parameters

chip_id*

Typestring

Required

execution_id*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"name": "string",

"status": "string",

"start_at": "string",

"end_at": "string",

"elapsed_time": "string",

"task": [

{

"task_id": "string",

"qid": "string",

"name": "string",

"upstream_id": "string",

"status": "string",

"message": "string",

"input_parameters": "string",

"output_parameters": "string",

"output_parameter_names": "string",

"note": "string",

"figure_path": "string",

"json_figure_path": "string",

"raw_data_path": "string",

"start_at": "string",

"end_at": "string",

"elapsed_time": "string",

"task_type": "string",

"default_view": true,

"over_threshold": true

}

],

"note": {

"additionalProperties": "string"

}

}

GET

/api/chip/{chip_id}/execution/{execution_id}

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/execution/{execution_id}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/execution/{execution_id}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/execution/{execution_id}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/execution/{execution_id}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch the multiplexer details

GET

/api/chip/{chip_id}/mux/{mux_id}

Fetch the multiplexer details.

Parameters

chip_id : str
ID of the chip
mux_id : int
ID of the multiplexer
current_user : User
Current authenticated user

Returns

MuxDetailResponse
Multiplexer details

Parameters

Path Parameters

chip_id*

Typestring

Required

mux_id*

Typeinteger

Required

Responses

Successful Response

Content-Type

application/json

{

"mux_id": 0,

"detail": {

"additionalProperties": {

}

}

}

GET

/api/chip/{chip_id}/mux/{mux_id}

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/mux/{mux_id}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/mux/{mux_id}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/mux/{mux_id}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/mux/{mux_id}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch the multiplexers

GET

/api/chip/{chip_id}/mux

Fetch the multiplexers.

Parameters

chip_id : str
ID of the chip
current_user : User
Current authenticated user

Returns

ListMuxResponse
Multiplexdetails

Parameters

Path Parameters

chip_id*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"muxes": {

"additionalProperties": {

}

}

}

GET

/api/chip/{chip_id}/mux

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/mux' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/mux', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/mux';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/mux'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch historical task results

GET

/api/chip/{chip_id}/task/qubit/{task_name}/history/{recorded_date}

Fetch historical task results for a specific date.

Parameters

chip_id : str
ID of the chip
task_name : str
Name of the task to fetch
recorded_date : str
Date to fetch history for (ISO format YYYY-MM-DD)
current_user : User
Current authenticated user

Returns

LatestTaskGroupedByChipResponse
Historical task results for all qubits on the specified date

Parameters

Path Parameters

chip_id*

Typestring

Required

task_name*

Typestring

Required

recorded_date*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"task_name": "string",

"result": {

"additionalProperties": {

}

}

}

GET

/api/chip/{chip_id}/task/qubit/{task_name}/history/{recorded_date}

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/task/qubit/{task_name}/history/{recorded_date}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/task/qubit/{task_name}/history/{recorded_date}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/task/qubit/{task_name}/history/{recorded_date}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/task/qubit/{task_name}/history/{recorded_date}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch the multiplexers

GET

/api/chip/{chip_id}/task/qubit/{task_name}

Fetch the multiplexers.

Parameters

Path Parameters

chip_id*

Typestring

Required

task_name*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"task_name": "string",

"result": {

"additionalProperties": {

}

}

}

GET

/api/chip/{chip_id}/task/qubit/{task_name}

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/task/qubit/{task_name}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/task/qubit/{task_name}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/task/qubit/{task_name}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/task/qubit/{task_name}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch historical task results

GET

/api/chip/{chip_id}/task/coupling/{task_name}/history/{recorded_date}

Fetch historical task results for a specific date.

Parameters

chip_id : str
ID of the chip
task_name : str
Name of the task to fetch
recorded_date : str
Date to fetch history for (ISO format YYYY-MM-DD)
current_user : User
Current authenticated user

Returns

LatestTaskGroupedByChipResponse
Historical task results for all qubits on the specified date

Parameters

Path Parameters

chip_id*

Typestring

Required

task_name*

Typestring

Required

recorded_date*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"task_name": "string",

"result": {

"additionalProperties": {

}

}

}

GET

/api/chip/{chip_id}/task/coupling/{task_name}/history/{recorded_date}

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/task/coupling/{task_name}/history/{recorded_date}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/task/coupling/{task_name}/history/{recorded_date}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/task/coupling/{task_name}/history/{recorded_date}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/task/coupling/{task_name}/history/{recorded_date}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch the multiplexers

GET

/api/chip/{chip_id}/task/coupling/{task_name}

Fetch the multiplexers.

Parameters

Path Parameters

chip_id*

Typestring

Required

task_name*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"task_name": "string",

"result": {

"additionalProperties": {

}

}

}

GET

/api/chip/{chip_id}/task/coupling/{task_name}

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/task/coupling/{task_name}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/task/coupling/{task_name}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/task/coupling/{task_name}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/task/coupling/{task_name}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch the timeseries task result by tag and parameter for a specific qid

GET

/api/chip/{chip_id}/parameter/{parameter}/qid/{qid}

Fetch the timeseries task result by tag and parameter for a specific qid.

Returns

TimeSeriesData: Time series data for the specified qid.

Parameters

Path Parameters

chip_id*

Typestring

Required

parameter*

Typestring

Required

qid*

Typestring

Required

Query Parameters

tag*

Typestring

Required

start_at*

Typestring

Required

end_at*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"data": {

"additionalProperties": [

]

}

}

GET

/api/chip/{chip_id}/parameter/{parameter}/qid/{qid}

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/parameter/{parameter}/qid/{qid}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/parameter/{parameter}/qid/{qid}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/parameter/{parameter}/qid/{qid}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/parameter/{parameter}/qid/{qid}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Fetch the timeseries task result by tag and parameter for all qids

GET

/api/chip/{chip_id}/parameter/{parameter}

Fetch the timeseries task result by tag and parameter for all qids.

Returns

TimeSeriesData: Time series data for all qids.

Parameters

Path Parameters

chip_id*

Typestring

Required

parameter*

Typestring

Required

Query Parameters

tag*

Typestring

Required

start_at*

Typestring

Required

end_at*

Typestring

Required

Responses

Successful Response

Content-Type

application/json

{

"data": {

"additionalProperties": [

]

}

}

GET

/api/chip/{chip_id}/parameter/{parameter}

Samples

cURL

curl -X GET \
'http://localhost/api/chip/{chip_id}/parameter/{parameter}' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/chip/{chip_id}/parameter/{parameter}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/chip/{chip_id}/parameter/{parameter}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/chip/{chip_id}/parameter/{parameter}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

file

Operations

GET/api/file/raw_dataGET/api/file/zip

---

download file

GET

/api/file/raw_data

Download a file.

Parameters

Query Parameters

path*

Typestring

Required

Responses

Successful Response

GET

/api/file/raw_data

Samples

cURL

curl -X GET \
'http://localhost/api/file/raw_data' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/file/raw_data', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/file/raw_data';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/file/raw_data'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

download file or directory as zip

GET

/api/file/zip

Download a file or directory as zip.

Parameters

Query Parameters

path*

Typestring

Required

Responses

Successful Response

GET

/api/file/zip

Samples

cURL

curl -X GET \
'http://localhost/api/file/zip' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/file/zip', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/file/zip';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/file/zip'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

auth

Operations

POST/api/auth/loginPOST/api/auth/registerGET/api/auth/mePOST/api/auth/logout

---

Login

POST

/api/auth/login

Login endpoint to authenticate user and return username.

Request Body

[object Object]

Responses

Successful Response

Content-Type

application/json

{

"additionalProperties": "string"

}

POST

/api/auth/login

Samples

cURL

curl -X POST \
'http://localhost/api/auth/login' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/auth/login', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/auth/login';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/auth/login'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

Register User

POST

/api/auth/register

Register a new user.

Request Body

{

"username": "string",

"password": "string",

"full_name": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"username": "string",

"full_name": "string",

"disabled": "string"

}

POST

/api/auth/register

Samples

cURL

curl -X POST \
'http://localhost/api/auth/register' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/auth/register', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/auth/register';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/auth/register'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

Read Users Me

GET

/api/auth/me

Get current user information.

Responses

Successful Response

Content-Type

application/json

{

"username": "string",

"full_name": "string",

"disabled": "string"

}

GET

/api/auth/me

Samples

cURL

curl -X GET \
'http://localhost/api/auth/me' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/auth/me', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/auth/me';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/auth/me'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Logout

POST

/api/auth/logout

Logout endpoint.

This endpoint doesn't need to do anything on the backend since the username is managed client-side.
The client will remove the username from cookies.

Responses

Successful Response

Content-Type

application/json

{

"additionalProperties": "string"

}

POST

/api/auth/logout

Samples

cURL

curl -X POST \
'http://localhost/api/auth/logout' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/auth/logout', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/auth/logout';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/auth/logout'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

authentication

Operations

POST/api/auth/loginPOST/api/auth/registerGET/api/auth/mePOST/api/auth/logout

---

Login

POST

/api/auth/login

Login endpoint to authenticate user and return username.

Request Body

[object Object]

Responses

Successful Response

Content-Type

application/json

{

"additionalProperties": "string"

}

POST

/api/auth/login

Samples

cURL

curl -X POST \
'http://localhost/api/auth/login' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/auth/login', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/auth/login';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/auth/login'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

Register User

POST

/api/auth/register

Register a new user.

Request Body

{

"username": "string",

"password": "string",

"full_name": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"username": "string",

"full_name": "string",

"disabled": "string"

}

POST

/api/auth/register

Samples

cURL

curl -X POST \
'http://localhost/api/auth/register' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/auth/register', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/auth/register';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/auth/register'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

Read Users Me

GET

/api/auth/me

Get current user information.

Responses

Successful Response

Content-Type

application/json

{

"username": "string",

"full_name": "string",

"disabled": "string"

}

GET

/api/auth/me

Samples

cURL

curl -X GET \
'http://localhost/api/auth/me' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/auth/me', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/auth/me';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/auth/me'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Logout

POST

/api/auth/logout

Logout endpoint.

This endpoint doesn't need to do anything on the backend since the username is managed client-side.
The client will remove the username from cookies.

Responses

Successful Response

Content-Type

application/json

{

"additionalProperties": "string"

}

POST

/api/auth/logout

Samples

cURL

curl -X POST \
'http://localhost/api/auth/logout' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/auth/logout', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/auth/logout';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/auth/logout'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

task

Operations

GET/api/tasks

---

Fetch all tasks

GET

/api/tasks

Fetch all tasks.

Args:

current_user (User): The current user.
backend (Optional[str]): Optional backend name to filter tasks by.

Returns:

list[TaskResponse]: The list of tasks.

Parameters

Query Parameters

backend

Optional backend name to filter tasks by

Responses

Successful Response

Content-Type

application/json

{

"tasks": [

{

"name": "string",

"description": "string",

"backend": "string",

"task_type": "string",

"input_parameters": {

"additionalProperties": {

}

},

"output_parameters": {

"additionalProperties": {

}

}

}

]

}

GET

/api/tasks

Samples

cURL

curl -X GET \
'http://localhost/api/tasks' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/tasks', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/tasks';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/tasks'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

parameter

Operations

GET/api/parameter

---

Fetch all parameters

GET

/api/parameter

Fetch all parameters.

Args:

current_user (User): The current user.

Returns: ListParameterResponse

Responses

Successful Response

Content-Type

application/json

{

"parameters": [

{

"username": "string",

"name": "string",

"unit": "string",

"description": "string"

}

]

}

GET

/api/parameter

Samples

cURL

curl -X GET \
'http://localhost/api/parameter' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/parameter', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/parameter';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/parameter'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

tag

Operations

GET/api/tag

---

list all tag

GET

/api/tag

Fetch all tasks.

Args:

current_user (User): The current user.

Returns:

ListTaskResponse: The list of tasks.

Responses

Successful Response

Content-Type

application/json

{

"tags": [

{

"name": "string"

}

]

}

GET

/api/tag

Samples

cURL

curl -X GET \
'http://localhost/api/tag' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/tag', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/tag';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/tag'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

device_topology

Operations

POST/api/device_topologyPOST/api/device_topology/plot

---

Get the device topology

POST

/api/device_topology

Get the device topology.

Request Body

{

"name": "string",

"device_id": "string",

"qubits": [

"string"

],

"exclude_couplings": [

"string"

],

"condition": {

"coupling_fidelity": {

"min": 0,

"max": 0,

"is_within_24h": true

},

"qubit_fidelity": {

"min": 0,

"max": 0,

"is_within_24h": true

},

"readout_fidelity": {

"min": 0,

"max": 0,

"is_within_24h": true

},

"only_maximum_connected": true

}

}

Responses

Successful Response

Content-Type

application/json

{

"name": "string",

"device_id": "string",

"qubits": [

{

"id": 0,

"physical_id": 0,

"position": {

"x": 0,

"y": 0

},

"fidelity": 0,

"meas_error": {

"prob_meas1_prep0": 0,

"prob_meas0_prep1": 0,

"readout_assignment_error": 0

},

"qubit_lifetime": {

"t1": 0,

"t2": 0

},

"gate_duration": {

"rz": 0,

"sx": 0,

"x": 0

}

}

],

"couplings": [

{

"control": 0,

"target": 0,

"fidelity": 0,

"gate_duration": {

"rzx90": 0

}

}

],

"calibrated_at": "string"

}

POST

/api/device_topology

Samples

cURL

curl -X POST \
'http://localhost/api/device_topology' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/device_topology', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/device_topology';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/device_topology'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

Get the device topology plot

POST

/api/device_topology/plot

Get the device topology as a PNG image.

Request Body

{

"name": "string",

"device_id": "string",

"qubits": [

{

"id": 0,

"physical_id": 0,

"position": {

"x": 0,

"y": 0

},

"fidelity": 0,

"meas_error": {

"prob_meas1_prep0": 0,

"prob_meas0_prep1": 0,

"readout_assignment_error": 0

},

"qubit_lifetime": {

"t1": 0,

"t2": 0

},

"gate_duration": {

"rz": 0,

"sx": 0,

"x": 0

}

}

],

"couplings": [

{

"control": 0,

"target": 0,

"fidelity": 0,

"gate_duration": {

"rzx90": 0

}

}

],

"calibrated_at": "string"

}

Responses

Successful Response

POST

/api/device_topology/plot

Samples

cURL

curl -X POST \
'http://localhost/api/device_topology/plot' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/device_topology/plot', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/device_topology/plot';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/device_topology/plot'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

---

backend

Operations

GET/api/backend

---

Get all backends

GET

/api/backend

Retrieve a list of all registered backends

Authorizations

APIKeyHeader

Type: API Key (header: X-Username)

Responses

Successful Response

Content-Type

application/json

[

{

"name": "string",

"username": "string"

}

]

GET

/api/backend

Samples

cURL

curl -X GET \
'http://localhost/api/backend' \
 -H "Content-Type: application/json"

JavaScript

fetch('http://localhost/api/backend', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'http://localhost/api/backend';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'http://localhost/api/backend'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

---

Powered by VitePress OpenAPI