Retrieve an ASCII-art rendering of the job's circuit(s).

GET/jobs/{job_qrn}/program/ascii

Authorizations

X-API-KEYstringheaderrequired

Authenticate requests using an API key linked to your qBraid account. Obtain your key by registering or logging in at account.qbraid.com.

Path Parameters

job_qrnstringrequired

The job qrn (qBraid Resource Name).

Response

200Success.
successbooleanrequired
dataobjectrequired
404Job not found.
409Program format not supported for ASCII rendering.
Get ASCII circuit diagram
curl --request GET \
  --url https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/program/ascii \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/program/ascii"
headers = {
    "X-API-KEY": "<api-key>"
}

response = requests.get(url, headers=headers)
print(response.json())
const url = "https://api-v2.qbraid.com/api/v1/jobs/{job_qrn}/program/ascii";
const options = {
  method: "GET",
  headers: {"X-API-KEY":"<api-key>"},
};

const response = await fetch(url, options);
console.log(await response.json());
{
  "success": true,
  "data": {
    "ascii": "<string>"
  }
}
{
  "success": false,
  "message": "<string>",
  "error": {
    "message": "<string>",
    "code": "<string>"
  }
}
{
  "success": false,
  "message": "<string>",
  "error": {
    "message": "<string>",
    "code": "<string>"
  }
}