Skip to main content
POST
/
quantum-jobs
cURL
curl --request POST \
  --url https://api.qbraid.com/api/quantum-jobs \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "qbraidDeviceId": "<string>",
  "bitcode": "aSDinaTvuI8gbWludGxpZnk=",
  "openQasm": "<string>",
  "circuitNumQubits": 123,
  "shots": 123,
  "tags": {}
}
'
{
    "timeStamps": {
      "createdAt": "2024-06-17T21:24:25.383Z",
      "endedAt": null,
      "executionDuration": null
    },
    "queuePosition": null,
    "queueDepth": null,
    "circuitNumQubits": 2,
    "circuitDepth": 1,
    "qbraidDeviceId": "aws_dm_sim",
    "qbraidJobId": "aws_dm_sim-test-qjob-f9yr2qzmxcqk8lv6a9t8",
    "status": "INITIALIZING",
    "vendor": "aws",
    "provider": "aws",
    "escrow": 3.75,
    "cost": null,
    "shots": 1000,
    "openQasm": "OPENQASM 3;\n qubit[2] q;\n h q[0];\n cx q[0], q[1];",
    "measurementCounts": null
}

{
    "timeStamps": {
      "createdAt": "2024-06-17T21:24:25.383Z",
      "endedAt": null,
      "executionDuration": null
    },
    "queuePosition": null,
    "queueDepth": null,
    "circuitNumQubits": 2,
    "circuitDepth": 1,
    "qbraidDeviceId": "aws_dm_sim",
    "qbraidJobId": "aws_dm_sim-test-qjob-f9yr2qzmxcqk8lv6a9t8",
    "status": "INITIALIZING",
    "vendor": "aws",
    "provider": "aws",
    "escrow": 3.75,
    "cost": null,
    "shots": 1000,
    "openQasm": "OPENQASM 3;\n qubit[2] q;\n h q[0];\n cx q[0], q[1];",
    "measurementCounts": null
}

Authorizations

​
api-key
string
header
required

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

Body

application/json
​
qbraidDeviceId
string
required

Target device on which to execute the quantum job.

​
bitcode
string<byte>

QIR (LLVM) bitcode for the quantum job, base64 encoded.

​
openQasm
string

OpenQASM 3 code for the quantum job.

​
circuitNumQubits
integer

Number of qubits used in the quantum circuit.

​
shots
integer

Number of times to execute the circuit.

​
tags
object

Tags associated with the quantum job for filtering and identification.

Response

Job created successfully