START NOW
Jobs

Get Job

GET/jobs/{job_qrn}

Retrieve a quantum job by its job QRN.

Args:

  • job_qrn (string): Job QRN (qBraid Resource Name)

Returns:

  • RuntimeJob object containing the job details

Raises:

  • 403: You do not have permission to access this job
  • 404: Job is not found
  • 422: Validation error if the job_qrn parameter is invalid

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

Job QRN (qBraid Resource Name)

Response

200Successful Response
successbooleanrequired
dataobjectrequired

Schema for runtime job model

403Forbidden
404Job Not Found
422Validation Error
GET/jobs/{job_qrn}
curl --request GET \
  --url https://api-v2.qbraid.com/api/v1/jobs/%3Cjob_qrn%3E \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api-v2.qbraid.com/api/v1/jobs/%3Cjob_qrn%3E"
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/%3Cjob_qrn%3E";
const options = {
  method: "GET",
  headers: {"X-API-KEY":"<api-key>"},
};

const response = await fetch(url, options);
console.log(await response.json());
{
  "success": true,
  "data": {
    "name": "<string>",
    "shots": 123,
    "deviceQrn": "<string>",
    "tags": {},
    "runtimeOptions": {},
    "jobQrn": "<string>",
    "batchJobQrn": "<string>",
    "vendor": "aws",
    "provider": "aqt",
    "status": "<string>",
    "statusMsg": "<string>",
    "experimentType": "<string>",
    "queuePosition": 123,
    "timeStamps": {
      "createdAt": "2024-01-01T00:00:00Z",
      "endedAt": "2024-01-01T00:00:00Z",
      "executionDuration": 123
    },
    "cost": 123,
    "estimatedCost": 123,
    "metadata": {}
  }
}
{
  "detail": "You do not have permission to access this job"
}
{
  "detail": "Job not found"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}