Create Job

curl --request POST \
  --url https://api-v2.qbraid.com/api/v1/jobs \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'email: <email>' \
  --data '
{
  "shots": 123,
  "deviceQrn": "<string>",
  "program": {
    "format": "qasm2",
    "data": "<unknown>"
  },
  "name": "<string>",
  "tags": {},
  "runtimeOptions": {}
}
'

{
  "name": "My quantum job",
  "shots": 1000,
  "deviceQrn": "aws:aws:sim:dm1",
  "tags": {},
  "runtimeOptions": {},
  "jobQrn": "aws:aws:qpu:dm1-a1b2-qjob-1234567890abcdef",
  "batchJobQrn": null,
  "vendor": "aws",
  "provider": "aws",
  "status": "INITIALIZING",
  "statusMsg": null,
  "experimentType": "gate_model",
  "queuePosition": null,
  "timeStamps": {
    "createdAt": "2025-01-15T10:30:00Z",
    "endedAt": null,
    "executionDuration": null
  },
  "cost": null,
  "estimatedCost": 3.75,
  "metadata": {}
}

Jobs

Create Job

Submit a quantum job to the specified device.

Request Body:

program (object, required): Quantum program with format and data fields
shots (integer, required): Number of shots to execute
deviceQrn (string, required): Device QRN (qBraid Resource Name)
runtimeOptions (object, optional): Runtime options
tags (object, optional): Job tags
name (string, optional): Job name

Headers:

email (string, required): User email
organization (string, optional): Organization QRN
X-API-KEY (string, required): Your qBraid API key

Returns:

RuntimeJob object with status INITIALIZING

Raises:

422: Validation error if required fields are missing or invalid

POST

jobs

Create Job

curl --request POST \
  --url https://api-v2.qbraid.com/api/v1/jobs \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'email: <email>' \
  --data '
{
  "shots": 123,
  "deviceQrn": "<string>",
  "program": {
    "format": "qasm2",
    "data": "<unknown>"
  },
  "name": "<string>",
  "tags": {},
  "runtimeOptions": {}
}
'

{
  "name": "My quantum job",
  "shots": 1000,
  "deviceQrn": "aws:aws:sim:dm1",
  "tags": {},
  "runtimeOptions": {},
  "jobQrn": "aws:aws:qpu:dm1-a1b2-qjob-1234567890abcdef",
  "batchJobQrn": null,
  "vendor": "aws",
  "provider": "aws",
  "status": "INITIALIZING",
  "statusMsg": null,
  "experimentType": "gate_model",
  "queuePosition": null,
  "timeStamps": {
    "createdAt": "2025-01-15T10:30:00Z",
    "endedAt": null,
    "executionDuration": null
  },
  "cost": null,
  "estimatedCost": 3.75,
  "metadata": {}
}

{
  "name": "My quantum job",
  "shots": 1000,
  "deviceQrn": "aws:aws:sim:dm1",
  "tags": {},
  "runtimeOptions": {},
  "jobQrn": "aws:aws:qpu:dm1-a1b2-qjob-1234567890abcdef",
  "batchJobQrn": null,
  "vendor": "aws",
  "provider": "aws",
  "status": "INITIALIZING",
  "statusMsg": null,
  "experimentType": "gate_model",
  "queuePosition": null,
  "timeStamps": {
    "createdAt": "2025-01-15T10:30:00Z",
    "endedAt": null,
    "executionDuration": null
  },
  "cost": null,
  "estimatedCost": 3.75,
  "metadata": {}
}

Authorizations

X-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-v2.qbraid.com.

Headers

string

required

User email

organization

string | null

Organization QRN

Body

application/json

Schema for job submission request body

shots

integer

required

Number of shots to execute

deviceQrn

string

required

qBraid device resource name

program

Program · object

required

Schema for quantum program

Show child attributes

name

string | null

Job name

Response

Successful Response

Schema for runtime job model

shots

integer

required

Number of shots to execute

deviceQrn

string

required

qBraid device resource name

jobQrn

string

required

qBraid job resource name

vendor

enum<string>

required

Vendor name

Available options:

aws,

azure,

ibm,

ionq,

qbraid

provider

enum<string>

required

Provider name

Available options:

aqt,

aws,

azure,

equal1,

ibm,

iqm,

ionq,

nec,

oqc,

pasqal,

quantinuum,

quera,

rigetti,

qbraid

status

string

required

Job status

experimentType

string

required

Experiment type

estimatedCost

number | null

required

Job estimated cost in credits

name

string | null

Job name

qBraid APIs

Devices

Jobs

Create Job

Authorizations

Headers

Body

Response