Skip to content

Oqtant REST API

The Oqtant REST API is the RESTful backend to both Oqtant and the Oqtant Web App. It's API provides endpoints that can be interacted with via Oqtant's Client API to execute and expand upon the same functionality found in the Oqtant Web App.

To see a list of available endpoints and try them out you can visit our OpenAPI documentation

Communication with the Oqtant REST API will need to be authorized via your Oqtant Account. To accomplish this you will need to find your authentication token and provide it when using the OpenAPI documentation. To do this you can follow the steps below:

** Both of these methods requires that oqtant be installed on your system and in a place where your python interpreter can access it. Ideally this would be inside of a virtual environment. For more information on how to set that up refer to our Installation Guide **

Authentication Token via Oqtant Notebooks

Oqtant provides a set of walkthrough and demo Jupyter notebooks which allow you to interact with the Oqtant system via python. within the oqtant.schemas.quantum_matter there is a factory that not only facilitates the user login, but also provides a client object to interact with the system.

qmf = QuantumMatterFactory()
qmf.get_login()

The line above when run inside of a Jupyter notebook cell will render a login widget that will handle your Oqtant account authentication. Once you have logged in you can then call the get_client method. This will provide a client for interacting with the system and show your daily job limits:

client = qmf.get_client()
Sample job limits output: ╒══════════════╤═══════════════════╤═══════════════╤═══════════════════════╕ │ Daily Used │ Daily Remaining │ Daily Limit │ Purchased Remaining │ ╞══════════════╪═══════════════════╪═══════════════╪═══════════════════════╡ │ 0 │ 10 │ 10 │ 10 │ ╘══════════════╧═══════════════════╧═══════════════╧═══════════════════════╛

To get started you will need to start up one of our provided Jupyter notebooks with the following command:

  1. Start up Jupyter
jupyter notebook

  1. Open up one of the Jupyter notebooks. Depending on the location you started Jupyter from you may need to navigate the file explorer interface of Jupyter to find them.

  2. Run the cell with the get_login() method call in the Jupyter notebook. When running the this cell you may be prompted to enter your account credentials if you have not logged in before/recently.

  3. Now that you are authenticated you can run the subsequent cells in the notebook.

Authentication Token via Pure Python

While we provide various Jupyter notebooks to be used with Oqtant, at its core it is a python library and can be used on its own. To be able to use the endpoint available in our OpenAPI documentation you will need to perform the following inside of a python interpreter:

  1. Inside of a terminal with oqtant available open a python interpreter by running python

  2. Import the get_user_tokenmethod

from oqtant.util.auth import get_user_token
  1. Call the imported method and assign the result to a variable
token = get_user_token()

  1. A new tab in your default browser will open where you will be prompted to log in with your Oqtant Account. Once logged in successfully you can close that tab and return to your python interpreter.

  2. Print the contents of the variable

print(token)
  1. Select all of the output from the printed variable and copy it to your clipboard. This is your token.

Authorizing OpenAPI Documentation

Now that you have your authentication token from one of the previous methods you can authorize the OpenAPI documentation to allow for interaction with the Oqtant REST API endpoints. To do this follow the below steps:

  1. Navigate to our OpenAPI documentation

  2. Once loaded you will see a list of the endpoints provided by the Oqtant REST API. Most of these will show a lock icon next to them on the right-hand side. Endpoints with a lock will require the authentication token we retrieved from the above methods.

  3. Near the top right-hand side of the page you will see a green button with the text Authorize. Clicking on this will open a pop-up with a form to input HTTPBearerinside.

  4. Paste the token from our clipboard into this field and click Authorize.

  5. You should now see a message that says Authorized. You can close the pop-up and begin using the endpoints that require an authentication token.