General methods

Service level methods

Health check

Check that the Qiskit Transpiler Service API is operating correctly.

HTTP Response Status Codes

Status code	Description
200	Successful Response

Code samples

GET

/health

curl -X GET \
  https://cloud-transpiler.quantum.ibm.com/health \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

import requests
 
response = requests.request(
    "GET",
    "https://cloud-transpiler.quantum.ibm.com/health",
    headers={
        "Accept": "application/json",
        "Authorization": "Bearer YOUR_API_TOKEN_HERE"
    },
)
print(response.json())

Responses

Status code

{
  "message": "example"
}

Status code

{
  "properties": {
    "message": {
      "type": "string",
      "title": "Message"
    }
  },
  "type": "object",
  "required": [
    "message"
  ],
  "title": "HealthcheckResponse"
}

Get versions

Get the versions of the Qiskit Transpiler Service API and Qiskit SDK

HTTP Response Status Codes

Status code	Description
200	Successful Response

Code samples

GET

/version

curl -X GET \
  https://cloud-transpiler.quantum.ibm.com/version \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

import requests
 
response = requests.request(
    "GET",
    "https://cloud-transpiler.quantum.ibm.com/version",
    headers={
        "Accept": "application/json",
        "Authorization": "Bearer YOUR_API_TOKEN_HERE"
    },
)
print(response.json())

Responses

Status code

{
  "api": "example",
  "qiskit": "example"
}

Status code

{
  "properties": {
    "api": {
      "type": "string",
      "title": "Api"
    },
    "qiskit": {
      "type": "string",
      "title": "Qiskit"
    }
  },
  "type": "object",
  "required": [
    "api",
    "qiskit"
  ],
  "title": "APIVersionResponse"
}