About cookies on this site Our websites require some cookies to function properly (required). In addition, other cookies may be used with your consent to analyze site usage, improve the user experience and for advertising. For more information, please review your options. By visiting our website, you agree to our processing of information as described in IBM’sprivacy statement. To provide a smooth navigation, your cookie preferences will be shared across the IBM web domains listed here.
General methods
Service level methods
Health check
Check that the Qiskit Transpiler Service API is operating correctly.
Code samples
GET
/healthcurl -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
{
"message": "example"
}
{
"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
Code samples
GET
/versioncurl -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
{
"api": "example",
"qiskit": "example"
}
{
"properties": {
"api": {
"type": "string",
"title": "Api"
},
"qiskit": {
"type": "string",
"title": "Qiskit"
}
},
"type": "object",
"required": [
"api",
"qiskit"
],
"title": "APIVersionResponse"
}
Was this page helpful?
Report a bug or request content on GitHub.